Loket.nl REST API Data Model
WorkflowAllowedTransitionsByEmployerId |
Workflows for the employer__Activity name:__ GetWorkflowsByEmployerIdGet the list of all workflows for an employer. All as in both open as finished workflows are returned.
Catalog: LoketNlRest
Schema: Workflows
This is a read-only table function. The loket.nl (REST) API may not support changing the data or the Invantive SQL driver for loket.nl (REST) does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the loket.nl (REST) API.
Select loket.nl (REST) API URL: /providers/employers/{employerId}/workflows
Insert loket.nl (REST) API URL: /providers/employers/{employerId}/workflows
Update loket.nl (REST) API URL: /providers/employers/{employerId}/workflows
Delete loket.nl (REST) API URL: /providers/employers/{employerId}/workflows
Field Selection Method: NotRequired
Base Path: _embedded[*].allowedTransitions[*]
Select loket.nl (REST) API Operation: get /providers/employers/{employerId}/workflows
Table Function Parameters
The following parameters can be used to control the behaviour of the table function WorkflowAllowedTransitionsByEmployerId. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
employerId |
guid |
☑ |
|
The unique identifier of the employer |
Table Function Columns
The columns of the table function WorkflowAllowedTransitionsByEmployerId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
assignee_role_description |
string |
|
☐ |
A description of the role. |
assignee_role_id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
assignee_user_formattedName |
string |
|
☐ |
preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\> |
assignee_user_id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
assignee_user_initials |
string(6) |
|
☐ |
The initials of the user |
assignee_user_lastName |
string(25) |
|
☐ |
The last name of the user |
assignee_user_prefix |
string(10) |
|
☐ |
The prefix of the user |
data |
string |
|
☐ |
A JSON representation of the mutation/data regarding this workflow |
description |
string(256) |
|
☐ |
The description of the transition (task) |
href |
string |
|
☐ |
|
httpVerb |
string |
|
☐ |
|
id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
initiatedBy_formattedName |
string |
|
☐ |
preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\> |
initiatedBy_id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
initiatedBy_initials |
string(6) |
|
☐ |
The initials of the user |
initiatedBy_lastName |
string(25) |
|
☐ |
The last name of the user |
initiatedBy_prefix |
string(10) |
|
☐ |
The prefix of the user |
initiatedOn |
datetime |
|
☐ |
|
lastModifiedBy_formattedName |
string |
|
☐ |
preformated user name for displaying. \<lastname\>\", \"\<initials\>\" \"\<prefix\> |
lastModifiedBy_id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
lastModifiedBy_initials |
string(6) |
|
☐ |
The initials of the user |
lastModifiedBy_lastName |
string(25) |
|
☐ |
The last name of the user |
lastModifiedBy_prefix |
string(10) |
|
☐ |
The prefix of the user |
lastModifiedOn |
datetime |
|
☐ |
date and time on which the last modification on the workflow was performed. This can be either by the system or a user. |
status_key |
int32 |
|
☐ |
The unique identifier |
status_value |
string |
|
☐ |
|
trigger_description |
string |
|
☐ |
|
trigger_id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
workflowTemplate_description |
string(256) |
|
☐ |
|
workflowTemplate_id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
workflowTemplate_version |
int32 |
|
☐ |
The version of the workflow template this workflow was based on. Changes to a workflow template do not affect existing workflows. |
13-05-2022 15:37 Version 22.1.40-BETA+3374
