Document: Taak aanmaken/aanpassen

Mogelijke HTTP methodes: POST,PUT

POST

 

Met deze aanroep kan er automatisch een taak in AuditCase worden aangemaakt. De aanroep bevat minimaal het klantnummer en type configuratie (wordt verstrekt door Change to Comm). Op basis van de configuratie wordt de taak automatisch aangevuld met gegevens van de klant in AuditCase.

Tijdens de aanroep zal de taak in AuditCase worden aangemaakt en zal het door de AuditCase validatie heen lopen. Indien het document niet aangemaakt kan worden dan krijgt de verzender hiervan bericht.

 

URL

 

{apiurl}/document/task/create/{klantnummer}/{configuratietype}

Voorbeeld: /ac/api/document/task/create/C1001005/dotoffice

URL deel

Value

{klantnummer}

Klantnummer of technische sleutel van klant

{configuratietype}

Door Change to Comm te verstrekken, bijvoorbeeld "dotoffice".

 

POST data (type:  multipart/form-data)

 

key voorbeeld value Optioneel Omschrijving
connectedDocText "Link naar document.pdf" Ja Titel van de link op taak
connectedDocPermLink "https://www.google.com/?q=changetocomm&documentid=[documentid]" Ja URL verwijzing van link op taak. Als er in deze url ergens de waarde "[documentid]" wordt opgenomen, dan wordt dit automatisch vervangen met dezelfde directe sleutel van de nieuwe taak.
connectedDocID "e-signeddocument" Ja Niet optioneel als bovengenoemde parameters worden meegestuurd. Hier komt een 'dummy' waarde in.

 

Response (voorbeeld)

  
{
"DocumentId": "4323C35D03983218C1257F340051D361",
"PermanentLink": "https://dev01.changetocomm.net/ac/redirect&target=document&clientkey=60CF6DB60A1F7EE7C1256D1E00305ED8&key=4323C35D03983218C1257F340051D361&modulename=TAKEN",
"Created": true

 

Property name

Value

Type

Created

True/false als actie gelukt is. Boolean

DocumentId

Directe sleutel naar de aangemaakte taak

String

PermanentLink

Permanente link naar de aangemaakte taak

String

 

 

PUT

 

Met deze aanroep kan een taak worden aangepast. Op dit moment is alleen de mogelijkheid aanwezig om de taak status aan te passen. De status kan op "nieuw" of "gereed" worden gezet.

 

URL

 

{apiurl}/document/task/{documentId}/updatestatus/{status}

Voorbeeld: ac/api/document/task/FD8FE4F8B452D884/updatestatus/nieuw

URL deel

Value

{documentId}

Directe sleutel van de aangemaakte taak. Deze sleutel wordt in de POST aanroep teruggegeven.

{status}

Nieuwe status van de taak. Mogelijke waarden:

"nieuw"

"gereed"

 

* Deze aanroepen zijn pas vanaf AuditCase versie 5.5 beschikbaar.

Hebt u meer vragen? Een aanvraag indienen
Mogelijk gemaakt door Zendesk