Versions Compared

Old Version 8

changes.mady.by.user Jeffrey Rijdes

Saved on

compared with

New Version Current

changes.mady.by.user Jeffrey Rijdes

Saved on

Key

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

...

Uitleg

Voorbeeld

HTTP Methode

De methode die je wilt uitvoeren voor dit verzoek. Dit kan een POST of GET methode zijn.

POST

Base URL

het eerste deel van de URL waar je een verzoek naar toe doet is je DocuFlow URL. Deze URL is ook te vinden bij de DocuFlow Settings → Settings → Environment Settings → DocuFlow URL.

https://documizersdemo.platform.documizers.com/DocuFlow

Endpoint

de operatie uit de DocuFlow API die je wilt uitvoeren. Een overzicht van alle endpoints kan je hier vinden: DocuFlow API - Endpoints .

/api/1.0/WorkspaceItems

Headers

In de header moet je de API Key meegeven, dat wordt hier uitgelegd: DocuFlow API - Authenicatie .

ApiKey: 6031086841ef43c0bdsa123fdsag

Parameters

Sommige GET endpoints verwachten ook een bepaalde parameter, dit wordt beschreven in de documentatie van een bepaalde endpoint.

?workspaceItemId=123&returnAllTags=true

Request body

Bij een POST endpoint moet je de request body vullen met gegevens van de opdracht, dit kan zijn in het formaat form-data of als JSON.

Indien er gegevens moeten worden meegegeven in de form-data, dan kan je de volgende type keys tegenkomen:

  • string

  • array

  • boolean

  • file

  • integer

Dit wordt nog uitgebreider beschreven in de documentatie van de endpoint.

Code Block
[
  {
    "workspaceItemId": 0,
    "name": "string",
    "dataType": "string",
    "data": "string",
    "isListData": true
  }
]

Anchor
request-body-author
request-body-author
Request body - Author

Bij het aanmaken van een workspaceitem of het uitvoeren van een proces moet je een Author opgeven. Deze moet overeenkomen met een gebruikersnaam van een gebruiker uit DocuFlow. De opdracht of het uitgevoerde proces wordt dan onder die gebruiker gelogd.