user-tasks

Operations addressed under /user-tasks — 11 operations.

get-user-task-list

GET

https://dg-sandbox.dgpays.com/bpm-service

/user-tasks

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Invokes the get-user-task-list service definition through GET /user-tasks.

Response body, read from the service source

The route declares its response as IEnumerable<UserTaskDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`ElementId`	`string`	no
`BpmnProcessId`	`string`	no
`ProcessDefinitionId`	`Guid`	no
`FormDefinitionId`	`string`	no

Member names are the service's declaration names.

get-user-task-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-user-task-list › Responses

Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.

object[]

Array of catalog-declared response records.

bpmnProcessId

string

elementId

string

formDefinitionId

string

id

string · uuid

processDefinitionId

string · uuid

create-user-task-status

POST

https://dg-sandbox.dgpays.com/bpm-service

/user-tasks

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

create-user-task-status › Request Body

approvalStatus

integer · int32 · required

assignCode

string · required

elementInstanceKey

integer · int64 · required

endDate

string · date · required

formId

string · uuid · required

processInstanceKey

integer · int64 · required

startDate

string · date-time · required

create-user-task-status › Responses

Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object
	type = array
	type = object · requires: data

Properties for Variant 1:

id

string · uuid

create-user-task-completed

POST

https://dg-sandbox.dgpays.com/bpm-service

/user-tasks/by-process-instance-key/{processInstanceKey}/by-element-instance-key/{elementInstanceKey}/complete

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

create-user-task-completed › path Parameters

processInstanceKey

integer · int64 · required

elementInstanceKey

integer · int64 · required

create-user-task-completed › Request Body

approvalStatus

integer · int32 · required

variables

object · required

create-user-task-completed › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.

No data returned

get-inbox-item-list

GET

https://dg-sandbox.dgpays.com/bpm-service

/user-tasks/inbox

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as IEnumerable<InboxItemListDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`StartDate`	`DateTime?`	yes
`StepStartDate`	`DateTime?`	yes
`FormId`	`Guid`	no
`StarterUserCode`	`string`	no
`StarterOrganizationName`	`string`	no
`ProcessName`	`string`	no
`StepName`	`string`	no
`CustomerNumber`	`string`	no
`ProcessInstanceKey`	`long`	no
`ProcessDefinitionId`	`Guid`	no
`BpmnProcessId`	`string`	no
`ProcessPriority`	`int?`	yes
`ProcessUserTaskTranslations`	`IEnumerable<ProcessUserTaskTranslationDto>` (collection)	no

Member names are the service's declaration names.

get-inbox-item-list › query Parameters

object

isWorkflowPool

boolean

orderBy

string

Default: id

orderSort

string

Default: asc

pageIndex

integer · int32

Default: 1

pageSize

integer · int32

Default: 15

get-inbox-item-list › Responses

object[]

Array of catalog-declared response records.

approvalStatus

integer · int32

bpmnProcessId

string

customerName

string

customerNumber

string

formId

string · uuid

id

string · uuid

isWorkflowPool

boolean

processDefinitionId

string · uuid

processInstanceKey

integer · int64

processName

string

processPriority

integer · int32

startDate

string · date-time

starterOrganizationName

string

starterUserCode

string

stepName

string

stepStartDate

string · date-time

transactionDate

string · date

GET/user-tasks/inbox

curl https://dg-sandbox.dgpays.com/bpm-service/user-tasks/inbox

Example Responses

[
  {
    "approvalStatus": 0,
    "bpmnProcessId": "bpmnProcessId",
    "customerName": "customerName",
    "customerNumber": "customerNumber",
    "formId": "00000000-0000-0000-0000-000000000000",
    "id": "00000000-0000-0000-0000-000000000000",
    "isWorkflowPool": true,
    "processDefinitionId": "00000000-0000-0000-0000-000000000000",
    "processInstanceKey": 0,
    "processName": "processName",
    "processPriority": 0,
    "startDate": "2024-08-25T15:00:00Z",
    "starterOrganizationName": "starterOrganizationName",
    "starterUserCode": "starterUserCode",
    "stepName": "stepName",
    "stepStartDate": "2024-08-25T15:00:00Z",
    "transactionDate": "2024-08-25"
  }
]

json

application/json

get-outbox-item-list

GET

https://dg-sandbox.dgpays.com/bpm-service

/user-tasks/outbox

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as IEnumerable<GetOutboxItemListDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`StartDate`	`DateTime`	no
`TransactionDate`	`DateOnly`	no
`FormId`	`Guid`	no
`CustomerNumber`	`string`	no
`ProcessName`	`string`	no
`StepName`	`string`	no
`StepStartDate`	`DateTime`	no
`ApprovalStatus`	`int`	no
`ProcessInstanceKey`	`long`	no
`ProcessInstanceId`	`Guid`	no
`BpmnProcessId`	`string`	no
`ProcessDefinitionId`	`Guid`	no
`StarterUserCode`	`string`	no
`InstanceState`	`string`	no

Member names are the service's declaration names.

get-outbox-item-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-outbox-item-list › Responses

object[]

Array of catalog-declared response records.

approvalStatus

integer · int32

bpmnProcessId

string

customerNumber

string

formId

string · uuid

id

instanceState

string

processDefinitionId

string · uuid

processInstanceId

string · uuid

processInstanceKey

integer · int64

processName

string

startDate

string · date-time

starterUserCode

string

stepName

string

stepStartDate

string · date-time

transactionDate

string · date

GET/user-tasks/outbox

curl https://dg-sandbox.dgpays.com/bpm-service/user-tasks/outbox

Example Responses

[
  {
    "approvalStatus": 0,
    "bpmnProcessId": "bpmnProcessId",
    "customerNumber": "customerNumber",
    "formId": "00000000-0000-0000-0000-000000000000",
    "id": {},
    "instanceState": "instanceState",
    "processDefinitionId": "00000000-0000-0000-0000-000000000000",
    "processInstanceId": "00000000-0000-0000-0000-000000000000",
    "processInstanceKey": 0,
    "processName": "processName",
    "startDate": "2024-08-25T15:00:00Z",
    "starterUserCode": "starterUserCode",
    "stepName": "stepName",
    "stepStartDate": "2024-08-25T15:00:00Z",
    "transactionDate": "2024-08-25"
  }
]

json

application/json

update-user-task-status-approval

PUT

https://dg-sandbox.dgpays.com/bpm-service

/user-tasks/{id}/portalroval

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

update-user-task-status-approval › path Parameters

id

string · uuid · required

update-user-task-status-approval › Request Body

approvalStatus

integer · int32 · required

update-user-task-status-approval › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.

No data returned

update-user-task-status

PUT

https://dg-sandbox.dgpays.com/bpm-service

/user-tasks/{id}/assign

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_BPM_25`	400	`TASK_ALREADY_ASSIGNED`	This record has been assigned to someone else.
`ERR_BPM_30`	400	`TASK_NOT_FOUND`	Task cannot be found.
`ERR_BPM_48`	400	`TASK_STATUS_NOT_VALID`	This record's assigned personnel information cannot be updated.

update-user-task-status › path Parameters

id

string · uuid · required

update-user-task-status › Request Body

assignCode

string · required

update-user-task-status › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.

No data returned

complete-user-task

POST

https://dg-sandbox.dgpays.com/bpm-service

/user-tasks/{id}/complete

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_BPM_27`	400	`TASK_ASSIGNED_ANOTHER_USER`	This task is assigned to another user.
`ERR_BPM_49`	400	`USER_TASK_NOT_EXISTS`	not published in this snapshot
`ERR_BPM_50`	400	`JOB_NOT_FOUND_FOR_THIS_PROCESS_ELEMENT_INSTANCE_KEY`	not published in this snapshot
`ERR_BPM_51`	400	`MULTIPLE_JOB_FOUND_FOR_THIS_PROCESS_ELEMENT_INSTANCE_KEY`	not published in this snapshot

complete-user-task › path Parameters

id

string · uuid · required

complete-user-task › Request Body

approvalStatus

integer · int32 · required

variables

object · required

complete-user-task › Responses

No data returned

get-user-task-status-detail-list

GET

https://dg-sandbox.dgpays.com/bpm-service

/user-tasks/{id}/details

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as GetUserTaskStatusDetailDto.

Field	Declared type	Nullable
`CorrelationId`	`Guid`	no
`ProcessInstanceKey`	`long`	no
`ProcessDefinitionKey`	`long`	no
`ProcessDefinitionId`	`Guid?`	yes
`ElementInstanceKey`	`long`	no
`ElementId`	`string`	no
`ElementName`	`string`	no
`FormId`	`Guid`	no
`ApprovelStatus`	`int`	no
`Mode`	`string`	no
`Variables`	`Dictionary<string, object>`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_BPM_30`	400	`TASK_NOT_FOUND`	Task cannot be found.

get-user-task-status-detail-list › path Parameters

id

string · uuid · required

get-user-task-status-detail-list › query Parameters

mode

string

get-user-task-status-detail-list › Responses

Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.

approvelStatus

integer · int32

correlationId

string · uuid

elementId

string

elementInstanceKey

integer · int64

elementName

formId

string · uuid

id

string · uuid

mode

string

processDefinitionId

string · uuid

processDefinitionKey

integer · int64

processInstanceKey

integer · int64

variables

object

update-user-task-status-unassign

PUT

https://dg-sandbox.dgpays.com/bpm-service

/user-tasks/{id}/unassign

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_BPM_30`	400	`TASK_NOT_FOUND`	Task cannot be found.
`ERR_BPM_48`	400	`TASK_STATUS_NOT_VALID`	This record's assigned personnel information cannot be updated.

update-user-task-status-unassign › path Parameters

id

string · uuid · required

update-user-task-status-unassign › Responses

No data returned

get-user-task-status-variables-by-id

GET

https://dg-sandbox.dgpays.com/bpm-service

/user-tasks/{id}/variables

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_BPM_30`	400	`TASK_NOT_FOUND`	Task cannot be found.

get-user-task-status-variables-by-id › path Parameters

id

string · uuid · required

get-user-task-status-variables-by-id › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.

No data returned

update-template-design-and-create-template-design-field user-tasks-status