LOloket-acc
Workflows

Details of a workflow

Activity name: <a href="https://developer.loket.nl/Activities/GetWorkflowByWorkflowId" target="_blank">GetWorkflowByWorkflowId</a>

Get the details of a workflow

get/v2/providers/employers/workflows/{workflowId}

Request

Path parameters

workflowIdstring uuid required

The unique identifier of the record

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required
Example:application/json;version=2018-01-01

The accept header is used to influence what type of output is returned and in most cases the version of the output

Response

OK

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "status": {
      "key": 1,
      "value": "In progress"
    },
    "functionalStatus": {
      "key": 1,
      "value": "Rejected"
    },
    "currentTask": {
      "type": "InputTask"
    },
    "assignees": [
      {
        "user": {
          "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
          "initials": "W",
          "prefix": "van de",
          "lastName": "Ven",
          "formattedName": "van de Ven W"
        },
        "role": {
          "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
          "description": "Employer"
        },
        "userResponsibility": {
          "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
          "description": "Payroll professional"
        }
      }
    ],
    "trigger": {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "description": "Address change for employee"
    },
    "workflowTemplate": {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "description": "Approval by employer"
    },
    "allowedTransitions": {
      "description": "Controleer de vergoedingen",
      "href": "https://api.loket.nl/v2/v2/providers/employers/workflows/{workflowId}/transition",
      "transitions": [
        {
          "action": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
          "description": "Approve"
        }
      ]
    },
    "comment": {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "userId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "timestamp": "2019-11-23T11:14:06Z",
      "text": "Moving house"
    },
    "initiatedOn": "2019-11-23T11:14:06Z",
    "initiatedBy": {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "initials": "I",
      "prefix": "de",
      "lastName": "Jong",
      "formattedName": "Jong, I"
    },
    "lastModifiedOn": "2019-11-23T11:14:06Z",
    "lastModifiedBy": {
      "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
      "initials": "I",
      "prefix": "de",
      "lastName": "Jong",
      "formattedName": "Jong, I"
    },
    "apiPayload": "{\"phoneNumber\":\"040-1234567\",\"mobilePhoneNumber\":\"06-12345678\",\"emailAddress\":\"test@email.com\",\"comment\":\"ESS contact workflow!\"}",
    "apiParams": {
      "employeeId": "d037bf68-d783-423b-b8e0-45aff6fe46b6",
      "contactId": "d037bf68-d783-423b-b8e0-45aff6fe46b6"
    },
    "comments": [
      {
        "commentedBy": {
          "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
          "initials": "I",
          "prefix": "de",
          "lastName": "Jong",
          "formattedName": "Jong, I"
        },
        "commentedOn": "2019-11-23T11:14:06Z",
        "comment": "Comment to initiator"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.