API - Opret blanket
Formål:
Du kan via denne vejledning se, hvordan du kan bruge API'et til XFlow til at oprette blanketter.
Forudsætning
Du skal have opsat et API til XFlow
Du skal have lavet en DNS-registrering til API’et
Du skal have et API token (se API - Adgang)
Sidst redigeret: 06/03-2025
Indholdsfortegnelse:
1. Vejledning
Du kan oprette blanketter via API'et og hertil komme ind på dokumentationen for dit API ved at sætte "api." foran URL'en til XFlow.
Eksempelvis: https://api.rc.xow.dk/
For at kunne oprette blanketter kræver det, at du kender ID’et på den arbejdsgang, der skal være skabelon for din blanket, og at du har ID på den bruger, der skal angives som opretter på blanketten.
Nedenfor kan du se, hvordan du henholdsvis kan søge brugere frem via API'et, og hvordan du opretter blanketter.
2. Søg bruger
Du kan fremsøge brugere via API'et ved at udforme en request på nedenstående form.
User/Search?email="string"
Du får her en kort beskrivelse af informationerne:
Navn: Navn på brugeren
Email: E-mailadresse på brugeren
UserId: ID på brugeren
Ved at lave søgninger på brugere i API'et får du dermed adgang til brugernes ID, som du skal bruge, når du skal oprette blanketter via API'et.
2.1. Fremsøg bruger gennem CPR-nummer
Du kan også fremsøge brugere via CPR-nummer på nedenstående form.
User/Search?=cpr=”string”
Du får følgende data tilbage.
Navn
Datatype
UserID
Guid
Name
String
String
Created
DateTime
Active
Boolean
Cpr
String
3. Opret blanket
Du kan oprette blanketter ved at udforme en request på nedenstående form:
{ "userId": "string", "processTemplateId": "string" }
Her er en kort beskrivelse af informationerne:
serId: ID på den bruger, der skal stå som opretter af blanketten og dermed være ansvarlig for at udføre første aktivitet
ProcessTemplateId: ID på den arbejdsgang, der er skabelon til den blanket, du gerne vil oprette
ID'et kan læses fra databasen i arbejdsgang-tabellen. For SaaS-kunder skal XFlow ind over for at finde det matchende ID.
Indtil videre kan du ikke fremsøge ID på den arbejdsgang, som du gerne vil oprette blanketterne på via API'et. Kontakt derfor XFlow for at få udleveret et udtræk med ID'er på arbejdsgangskabeloner.
