Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Beskrivning

Camunda BPM är en processmotor och en viktig del i Sundsvalls kommuns strategi för att bygga en generell ärendehantering.

Det finns ett Rest-api för att prata med Camunda, men det kräver genomgripande kunskap av hur processmotorn fungerar.
Därför finns ProcessEngine-api:et för att göra det enklare att prata med processmotorn.

https://github.com/Sundsvallskommun/process-engine-parking-permit

Livscykelstatus

Test

Lösningsbeskrivning

API:et är ett Spring Boot-projekt som försöker efterlikna övriga API:er inom Sundsvalls kommuns utvecklingsfabrik. Därför används dept-44-dependecies för till exempel Webclient och Test.

Hantering av personuppgifter

Inga personuppgifter hanteras, endast ärendenummer skickas in och sparas i processmotorns historik. För tillfället finns ingen databas eller liknande kopplad till API:et.

API specifikation

StartProcess

Starta en ny processinstans med namn och ärende id.

POST

/process-engine/startprocess

Body:

Code Block
{
    "processName":"Namn",
    "caseNumber": "123",
    "processInstanceId":"1"

}

UpdateProcess

Updatera en process som körs och väntar på svar innan den kör vidare. Skicka med processInstanceId för den process som det gäller.

POST

/process-engine/updateprocess

Body:

Code Block
{
    "processName":"Namn",
    "caseNumber": "123",
    "processInstanceId":"1"

}

<API specifikation i Swagger-UI (använd plug-in).
Publicera även en API-Key mot Sandbox som gör att man kan testköra API:et.

API-specifikationen skall såklart reflektera att API-design följts fullt ut.>

Säkerhetsklassning

Säkerhetsklass ?

Autentiseringsmetod: API Key

(Ref: Säkerhetsklassning av APIer )

API-ägare

<Kontaktuppgifter till den verksamhet som äger APIets livscykel>

Teknisk ägare

<Kontaktuppgifter till utvecklare/teknisk förvaltare>

Källkod

<Länk till källkoden på GIThub (om det finns)>

FAQ

<FAQ>https://github.com/Sundsvallskommun/process-engine-parking-permit