process-definitions

Operations addressed under /process-definitions — 14 operations.

aurax-bff-redirect-get-process-definition-list

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/process-definitions

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<ProcessDefinitionDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`BpmnProcessId`	`string`	no
`ProcessDefinitionKey`	`long?`	yes
`ResourceName`	`string`	no
`DeploymentTime`	`DateTime`	no
`VersionNo`	`int?`	yes
`WaitForResponse`	`bool`	no
`CanStarterUserApprove`	`bool`	no
`CanPreviousUserApprove`	`bool`	no
`UsageType`	`int?`	yes
`ProcessName`	`string`	no
`ProcessPriority`	`int?`	yes

Member names are the service's declaration names.

aurax-bff-redirect-get-process-definition-list › 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

aurax-bff-redirect-deploy-process-flow

POST

https://dg-sandbox.dgpays.com/aurax-bff-service

/process-definitions

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

aurax-bff-redirect-deploy-process-flow › Responses

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

No data returned

aurax-bff-redirect-get-process-definition-by-bpmn-process-id

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/process-definitions/by-bpmn-process-id/{bpmnProcessId}

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 ProcessDefinitionExtendedDto.

Field	Declared type	Nullable
`XmlResource`	`string`	no
`Id`	`Guid`	no
`BpmnProcessId`	`string`	no
`ProcessDefinitionKey`	`long?`	yes
`ResourceName`	`string`	no
`DeploymentTime`	`DateTime`	no
`VersionNo`	`int?`	yes
`WaitForResponse`	`bool`	no
`CanStarterUserApprove`	`bool`	no
`CanPreviousUserApprove`	`bool`	no
`UsageType`	`int?`	yes
`ProcessName`	`string`	no
`ProcessPriority`	`int?`	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_BPM_21`	400	`PROCESS_DEFINITION_IS_NOT_FOUND`	Process definition cannot be found.

aurax-bff-redirect-get-process-definition-by-bpmn-process-id › path Parameters

bpmnProcessId

string · required

Present in the route template but not declared as a Route-bound field in the catalog.

aurax-bff-redirect-get-process-definition-by-bpmn-process-id › Responses

No data returned

aurax-bff-redirect-get-process-definition-by-id

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/process-definitions/{id}

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 ProcessDefinitionByIdDto.

Field	Declared type	Nullable
`Name`	`string`	no
`Path`	`string`	no
`OperationType`	`int`	no
`XmlResource`	`string`	no
`Id`	`Guid`	no
`BpmnProcessId`	`string`	no
`ProcessDefinitionKey`	`long?`	yes
`ResourceName`	`string`	no
`DeploymentTime`	`DateTime`	no
`VersionNo`	`int?`	yes
`WaitForResponse`	`bool`	no
`CanStarterUserApprove`	`bool`	no
`CanPreviousUserApprove`	`bool`	no
`UsageType`	`int?`	yes
`ProcessName`	`string`	no
`ProcessPriority`	`int?`	yes

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_BPM_21`	400	`PROCESS_DEFINITION_IS_NOT_FOUND`	Process definition cannot be found.

aurax-bff-redirect-get-process-definition-by-id › path Parameters

id

string · required

Present in the route template but not declared as a Route-bound field in the catalog.

aurax-bff-redirect-get-process-definition-by-id › Responses

No data returned

aurax-bff-redirect-update-process-flow

PUT

https://dg-sandbox.dgpays.com/aurax-bff-service

/process-definitions/{id}

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

aurax-bff-redirect-update-process-flow › path Parameters

id

string · required

Present in the route template but not declared as a Route-bound field in the catalog.

aurax-bff-redirect-update-process-flow › Responses

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

No data returned

aurax-bff-get-user-task-process-element

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/process-definitions/{id}/by-process-definition-key/{processDefinitionKey}/elements/{elementId}/user-tasks/first

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 UserTaskProcessElementDto.

Field	Declared type	Nullable
`ProcessDefinitionId`	`Guid`	no
`ProcessElementId`	`Guid`	no

Member names are the service's declaration names.

aurax-bff-get-user-task-process-element › path Parameters

id

string · required

Present in the route template but not declared as a Route-bound field in the catalog.

processDefinitionKey

string · required

Present in the route template but not declared as a Route-bound field in the catalog.

elementId

string · required

Present in the route template but not declared as a Route-bound field in the catalog.

aurax-bff-get-user-task-process-element › Responses

No data returned

aurax-bff-redirect-get-process-definition-detail-list

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/process-definitions/{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 IEnumerable<ProcessDefinitionDetailDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`ProcessDefinitionKey`	`long`	no
`ResourceName`	`string`	no
`XmlResource`	`string`	no
`VersionNo`	`int`	no
`DeploymentTime`	`DateTime`	no
`UsageType`	`int?`	yes
`ProcessName`	`string`	no

Member names are the service's declaration names.

aurax-bff-redirect-get-process-definition-detail-list › path Parameters

id

string · required

Present in the route template but not declared as a Route-bound field in the catalog.

aurax-bff-redirect-get-process-definition-detail-list › Responses

No data returned

aurax-bff-get-process-definition-user-task-list

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/process-definitions/{id}/elements/user-tasks

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 PagedResultDto<ProcessElementDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`ElementId`	`string`	no
`BpmnElementType`	`string`	no

Member names are the service's declaration names.

aurax-bff-get-process-definition-user-task-list › path Parameters

id

string · required

Present in the route template but not declared as a Route-bound field in the catalog.

aurax-bff-get-process-definition-user-task-list › Responses

No data returned

aurax-bff-redirect-get-process-user-task-list

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/process-definitions/{id}/user-tasks

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<ProcessUserTaskDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`ProcessDefinitionId`	`Guid`	no
`OrganizationApprovementType`	`int`	no
`ElementId`	`string`	no
`ValidationSchema`	`string`	no
`Translations`	`IEnumerable<ProcessUserTaskTranslationDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_BPM_21`	400	`PROCESS_DEFINITION_IS_NOT_FOUND`	Process definition cannot be found.

aurax-bff-redirect-get-process-user-task-list › path Parameters

id

string · required

Present in the route template but not declared as a Route-bound field in the catalog.

aurax-bff-redirect-get-process-user-task-list › Responses

No data returned

aurax-bff-redirect-deploy-process-user-task

POST

https://dg-sandbox.dgpays.com/aurax-bff-service

/process-definitions/{id}/user-tasks

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

aurax-bff-redirect-deploy-process-user-task › path Parameters

id

string · required

Present in the route template but not declared as a Route-bound field in the catalog.

aurax-bff-redirect-deploy-process-user-task › Responses

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

No data returned

aurax-bff-get-process-user-task-action-list

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/process-definitions/{id}/user-tasks/{elementId}/actions-with-code

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<ProcessUserTaskActionDto>.

Field	Declared type	Nullable
`ActionId`	`Guid`	no
`ActionCode`	`string`	no
`ActionName`	`string`	no

Member names are the service's declaration names.

aurax-bff-get-process-user-task-action-list › path Parameters

id

string · uuid · required

elementId

string · required

aurax-bff-get-process-user-task-action-list › Responses

Success. An exact, uniquely bound route registration classifies this response as a collection.

No data returned

aurax-bff-redirect-get-process-user-task-by-id

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/process-definitions/{id}/user-tasks/{processUserTaskId}

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 ProcessUserTaskDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`ProcessDefinitionId`	`Guid`	no
`OrganizationApprovementType`	`int`	no
`ElementId`	`string`	no
`ValidationSchema`	`string`	no
`Translations`	`IEnumerable<ProcessUserTaskTranslationDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_BPM_21`	400	`PROCESS_DEFINITION_IS_NOT_FOUND`	Process definition cannot be found.
`ERR_BPM_57`	400	`PROCESS_USER_TASK_NOT_EXISTS`	Process User Task Id not found.

aurax-bff-redirect-get-process-user-task-by-id › path Parameters

id

string · required

Present in the route template but not declared as a Route-bound field in the catalog.

processUserTaskId

string · required

Present in the route template but not declared as a Route-bound field in the catalog.

aurax-bff-redirect-get-process-user-task-by-id › Responses

No data returned

aurax-bff-redirect-get-process-user-task-action-map-list

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/process-definitions/{id}/user-tasks/{processUserTaskId}/action-maps

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<ProcessUserTaskActionMapDto>.

Field	Declared type	Nullable
`ProcessUserTaskId`	`Guid`	no
`Id`	`Guid`	no
`ActionId`	`Guid`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_BPM_21`	400	`PROCESS_DEFINITION_IS_NOT_FOUND`	Process definition cannot be found.
`ERR_BPM_57`	400	`PROCESS_USER_TASK_NOT_EXISTS`	Process User Task Id not found.

aurax-bff-redirect-get-process-user-task-action-map-list › path Parameters

id

string · required

Present in the route template but not declared as a Route-bound field in the catalog.

processUserTaskId

string · required

Present in the route template but not declared as a Route-bound field in the catalog.

aurax-bff-redirect-get-process-user-task-action-map-list › Responses

No data returned

aurax-bff-get-authorized-user-task-action-list

GET

https://dg-sandbox.dgpays.com/aurax-bff-service

/process-definitions/{processDefinitionId}/user-tasks/{elementId}/authorized-actions

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 AuthorizedUserTaskDto.

Field	Declared type	Nullable
`ValidationSchema`	`string`	no
`Actions`	`IEnumerable<AuthorizedUserTaskActionDto>` (collection)	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_AURAX_26`	400	`NO_ACTIONS_IN_KYCL`

aurax-bff-get-authorized-user-task-action-list › path Parameters

processDefinitionId

string · uuid · required

elementId

string · required

aurax-bff-get-authorized-user-task-action-list › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

process-definition-drafts process-domain-inbox-event-list