Dokumentation: IMS Case API – Visma IMS A/S

Her kan du finde information vedr. IMS Case standard API. API'et udvides løbende med nye end points, og bliver automatisk opdateret hos de kunder, som har købt API funktionen til deres eksterne systemer.

Denne dokumentation giver adgang til vores demo Postman collection, hvor man kan finde de endpoints, som lige nu er tilgængelige i vores API. De er også nærmere beskrevet herunder.

Kontakt vores booking på imsbooking@visma.com for bestilling og opsætning af API til din IMS Case installation.

Formål
Formålet er at udstille en service, der kan benyttes af eksterne systemer til at oprette, søge og hente
data i objekter. Oprette sager, kontakter og dokumenter samt søge og relatere sager til kontakter i IMS Case.

Begreber
Journalplan med nøgler er en slags pegepind, der kan indeholde andre nøgler og sager. Nøgler bruges til at opbygge en struktur/plan i sit arkiv. Nøgler er altid placeret under en anden nøgle eller en rodnøgle.

Sager vil være placeret i nøgler, hvis systemet arbejder med journalplaner. Journalplaner er ikke obligatoriske i IMS Case. Nøgler er ikke rettighedsstyrende.
Sager indeholder dokumenter samt foldere med dokumenter. Sager er altid placeret under en nøgle, hvis systemet arbejder med aktiverede journalplaner.

Dokumenter indeholder et hoveddokument (en fil), bilag (x antal filer), referencer til andre sager eller dokumenter, og metadata informationer. Metadata er diverse info som Titel, Opretter, Ansvarlig, Beskrivelse, adgangsgruppe,
kassationsregel osv.

Dokument-, kontakt- eller sagsid. og Alle sager, dokumenter og kontakter har et ID. Id'et er en unik identifikator. I systemet kan man arbejde med arkivnummer eller med ID. Hvis man arbejder med arkivnummer, vil man kunne se hvor f.eks. et dokument er placeret i en plan. Arkivnummer oprettes automatisk og navngives som [nøgle].[sag]/[emne]. Nøgler nummereres lokalt, sager og emner globalt. Arkivnummer findes ikke på kontakter.

Arkivplan eksempel:

1. Administration (nøgle)
- 1.1 Breve (undernøgle)
  - 1.1.1 information (undernøgle)
    - Sag 1 (sag)
    - Sag 2 (sag)
  - 1.1.1 information (undernøgle)
    - - Sag 3 (sag)
      - Sag 4 (sag)
2 Ledelse (nøgle)
- Sag 1 (sag)
- Sag 2 (sag)

Oplysninger om selve sitet
Når sitet er sat op på en adresse https://XXX/XXX, er det disse adresser man skal benytte.
Api - https://documenter.getpostman.com/view/19658159/UVysywFD

Login
Når man logger ind fås en JWT token, som man skal bruge i de efterfølgende kald.
Man kan logge ind med client login eller userlogin:

Client Login: https://documenter.getpostman.com/view/19658159/UVysywFD#0b6c37d8-6689-4ab7-93a0-e53310626860

User login: https://documenter.getpostman.com/view/19658159/UVysywFD#0dabf5c4-d9d0-499a-a839-9a5e55f89435

Hente oplysninger om datamodel:
Her kan man se sagsskabeloner samt custom fields relationer til skabelonerne.
Man kan også se alle de relationer, der er i vores domæne i forhold til dokumenter, filer, sager og felter.

Hver sagsskabelon har sit eget end-point. Datamodellen kan findes her:
https://documenter.getpostman.com/view/19658159/UVysywFD#43438f82-0d02-4a53-bdea-4fc5848c19d4

Hente journalplanen:
Ved hentning af journalplanen, ses alle relationer der findes i planen for nøgler og sager.
Det ID man kan bruge i de andre kald i APIet, kan findes ved at fjerne "workspace/" -delen fra NodeRefId.

Eksempelvis kan man se en sag og benytte Id’et, som man kan bruge til at hente information om sagen vha. {{host}}/v1/Cases(1f7e301a-5e17-4d4e-a9d7-918a35787f4b)

Man bør derfor ikke bruge det på følgende måde:
{{host}}/v1/Cases(workspace/1f7e301a-5e17-4d4e-a9d7-918a35787f4b)

For mere info se vores Postman colletion https://documenter.getpostman.com/view/19658159/UVysywFD#496d9a0e-8972-4104-a393-8e7430137bc4

Nedenstående er de eksisterende kald, som kan foretages i IMS Case API'et i dag.

Søge, oprette, hente sager:
Der kan søges på generelle sager, som ikke har en sagsskabelon. Der kan søges på sagernes standard attributter. Disse kan findes i datamodellen under entity “Cases”.

Link til søgning på sag: https://documenter.getpostman.com/view/19658159/UVysywFD#974e7d4a-1daa-459a-a688-a211cd34f182

Link til søgning for en specifik sagsskabelon:
https://documenter.getpostman.com/view/19658159/UVysywFD#3fe6c522-d633-4638-9344-e0a5ca01feb8

Opret sag: https://documenter.getpostman.com/view/19658159/UVysywFD#fec183a9-c48b-44d9-81b8-
1bf5e4b3a93b

Opdater sagsejer på eksisterende sag:

Opdater sag: https://documenter.getpostman.com/view/19658159/UVysywFD#23365768-3778-4b96-a291-aa0df8e61c4c

For at kunne opdatere sagsejer, er det nødvendigt at hente en liste af brugere.

Hent brugere:

Hent: https://www.postman.com/bold-space-997235/workspace/visma-ims-public/documentation/19658159-d011a09c-b80a-464e-bf23-45834070001a?entity=request-24f0e982-6325-4801-9625-5361ef4f9ac5

Oprette, hente dokumenter

Opret: https://documenter.getpostman.com/view/19658159/UVysywFD#7ba1a5c2-2e64-4681-a3b7-2acf908087d6
Hent: https://documenter.getpostman.com/view/19658159/UVysywFD#dd5b14fc-63d4-48e1-acf5-1d2c1af89d77

Hente og oprette filer:

Hent: