process-definitions

Operations addressed under /process-definitions — 31 operations.

get-process-definition-list

GET

https://dg-sandbox.dgpays.com/bpm-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.

get-process-definition-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-process-definition-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

canPreviousUserApprove

boolean

canStarterUserApprove

boolean

deploymentTime

string · date-time

id

string · uuid

processDefinitionKey

integer · int64

processName

string

processPriority

integer · int32

resourceName

string

usageType

integer · int32

Permitted values — validated against the usage_type parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Service`	en: Service · ar: خدمة
`2`	`BPM`	en: BPM · ar: معدل ضربات القلب
`4`	`Rule`	en: Rule · ar: قاعدة
`3`	`Formula`	en: Formula · ar: الصيغة
`5`	`DistributedQuery`	en: Distributed Query · ar: استعلام موزع
`6`	`Keycloak`	en: Keycloak Service · ar: خدمة كي-كلاوك
`7`	`Camunda`	en: Camunda Service · ar: خدمة كاموندা
`8`	`TaskList`	en: Task List · ar: قائمة المهام

version

integer · int32

waitForResponse

boolean

GET/process-definitions

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions

Example Responses

[
  {
    "bpmnProcessId": "bpmnProcessId",
    "canPreviousUserApprove": true,
    "canStarterUserApprove": true,
    "deploymentTime": "2024-08-25T15:00:00Z",
    "id": "00000000-0000-0000-0000-000000000000",
    "processDefinitionKey": 0,
    "processName": "processName",
    "processPriority": 0,
    "resourceName": "resourceName",
    "usageType": 0,
    "version": 0,
    "waitForResponse": true
  }
]

application/json

create-process-definition

POST

https://dg-sandbox.dgpays.com/bpm-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 returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.

Field	Name on the wire	Declared type	Nullable
`Id`	`id`	`Guid`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_BPM_20`	400	`PROCESS_DEFINITION_ALREADY_EXISTS`	Process definition already exists.

create-process-definition › Request Body

bpmnProcessId

string · required

canPreviousUserApprove

boolean · required

canStarterUserApprove

boolean · required

processDefinitionKey

integer · int64 · required

processName

string · required

resource

string · required

resourceName

string · required

usageType

integer · int32 · required

Permitted values — validated against the usage_type parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Service`	en: Service · ar: خدمة
`2`	`BPM`	en: BPM · ar: معدل ضربات القلب
`4`	`Rule`	en: Rule · ar: قاعدة
`3`	`Formula`	en: Formula · ar: الصيغة
`5`	`DistributedQuery`	en: Distributed Query · ar: استعلام موزع
`6`	`Keycloak`	en: Keycloak Service · ar: خدمة كي-كلاوك
`7`	`Camunda`	en: Camunda Service · ar: خدمة كاموندা
`8`	`TaskList`	en: Task List · ar: قائمة المهام

version

integer · int32 · required

waitForResponse

boolean · required

create-process-definition › Responses

Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.

Body shape declared by the exact route registration for the catalog's 200 response.

id

string · uuid

Identifier returned by the command.

POST/process-definitions

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "bpmnProcessId": "",
  "canPreviousUserApprove": false,
  "canStarterUserApprove": false,
  "processDefinitionKey": 0,
  "processName": "",
  "resource": "",
  "resourceName": "",
  "usageType": 0,
  "version": 0,
  "waitForResponse": false
}'

Example Request Body

{
  "bpmnProcessId": "",
  "canPreviousUserApprove": false,
  "canStarterUserApprove": false,
  "processDefinitionKey": 0,
  "processName": "",
  "resource": "",
  "resourceName": "",
  "usageType": 0,
  "version": 0,
  "waitForResponse": false
}

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000"
}

application/json

get-process-definition-by-bpmn-process-id

GET

https://dg-sandbox.dgpays.com/bpm-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.

get-process-definition-by-bpmn-process-id › path Parameters

bpmnProcessId

string · required

get-process-definition-by-bpmn-process-id › 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.

bpmnProcessId

string

deploymentTime

string · date-time

id

string · uuid

processDefinitionKey

integer · int64

resourceName

string

versionNo

integer · int32

waitForResponse

boolean

xmlResource

string

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

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/by-bpmn-process-id/:bpmnProcessId

Example Responses

{
  "bpmnProcessId": "bpmnProcessId",
  "deploymentTime": "2024-08-25T15:00:00Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "processDefinitionKey": 0,
  "resourceName": "resourceName",
  "versionNo": 0,
  "waitForResponse": true,
  "xmlResource": "xmlResource"
}

application/json

get-process-definition-not-deployed-list

GET

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

/process-definitions/not-deployed

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.

get-process-definition-not-deployed-list › query Parameters

object

get-process-definition-not-deployed-list › Responses

object[]

Array of catalog-declared response records.

bpmnProcessId

string

canPreviousUserApprove

boolean

canStarterUserApprove

boolean

deploymentTime

string · date-time

id

string · uuid

processDefinitionKey

integer · int64

resourceName

string

versionNo

integer · int32

waitForResponse

boolean

GET/process-definitions/not-deployed

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/not-deployed

Example Responses

[
  {
    "bpmnProcessId": "bpmnProcessId",
    "canPreviousUserApprove": true,
    "canStarterUserApprove": true,
    "deploymentTime": "2024-08-25T15:00:00Z",
    "id": "00000000-0000-0000-0000-000000000000",
    "processDefinitionKey": 0,
    "resourceName": "resourceName",
    "versionNo": 0,
    "waitForResponse": true
  }
]

application/json

get-process-definition-by-id

GET

https://dg-sandbox.dgpays.com/bpm-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.

get-process-definition-by-id › path Parameters

id

string · uuid · required

get-process-definition-by-id › Responses

bpmnProcessId

string

canPreviousUserApprove

boolean

canStarterUserApprove

boolean

deploymentTime

string · date-time

id

string · uuid

name

string

operationType

integer · int32

path

string

processDefinitionKey

integer · int64

processPriority

integer · int32

resourceName

string

usageType

integer · int32

Permitted values — validated against the usage_type parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Service`	en: Service · ar: خدمة
`2`	`BPM`	en: BPM · ar: معدل ضربات القلب
`4`	`Rule`	en: Rule · ar: قاعدة
`3`	`Formula`	en: Formula · ar: الصيغة
`5`	`DistributedQuery`	en: Distributed Query · ar: استعلام موزع
`6`	`Keycloak`	en: Keycloak Service · ar: خدمة كي-كلاوك
`7`	`Camunda`	en: Camunda Service · ar: خدمة كاموندা
`8`	`TaskList`	en: Task List · ar: قائمة المهام

versionNo

integer · int32

waitForResponse

boolean

xmlResource

string

GET/process-definitions/{id}

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id

Example Responses

{
  "bpmnProcessId": "bpmnProcessId",
  "canPreviousUserApprove": true,
  "canStarterUserApprove": true,
  "deploymentTime": "2024-08-25T15:00:00Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "operationType": 0,
  "path": "path",
  "processDefinitionKey": 0,
  "processPriority": 0,
  "resourceName": "resourceName",
  "usageType": 0,
  "versionNo": 0,
  "waitForResponse": true,
  "xmlResource": "xmlResource"
}

application/json

update-process-definition

PUT

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

/process-definitions/{id}

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_21`	400	`PROCESS_DEFINITION_IS_NOT_FOUND`	Process definition cannot be found.

update-process-definition › path Parameters

id

string · uuid · required

update-process-definition › Request Body

canPreviousUserApprove

boolean · required

canStarterUserApprove

boolean · required

processDefinitionKey

integer · int64 · required

processName

string · required

resource

string · required

resourceName

string · required

usageType

integer · int32 · required

Permitted values — validated against the usage_type parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Service`	en: Service · ar: خدمة
`2`	`BPM`	en: BPM · ar: معدل ضربات القلب
`4`	`Rule`	en: Rule · ar: قاعدة
`3`	`Formula`	en: Formula · ar: الصيغة
`5`	`DistributedQuery`	en: Distributed Query · ar: استعلام موزع
`6`	`Keycloak`	en: Keycloak Service · ar: خدمة كي-كلاوك
`7`	`Camunda`	en: Camunda Service · ar: خدمة كاموندা
`8`	`TaskList`	en: Task List · ar: قائمة المهام

version

integer · int32 · required

waitForResponse

boolean · required

processPriority

integer · int32

update-process-definition › 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

PUT/process-definitions/{id}

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "canPreviousUserApprove": false,
  "canStarterUserApprove": false,
  "processDefinitionKey": 0,
  "processName": "",
  "processPriority": 0,
  "resource": "",
  "resourceName": "",
  "usageType": 0,
  "version": 0,
  "waitForResponse": false
}'

Example Request Body

{
  "canPreviousUserApprove": false,
  "canStarterUserApprove": false,
  "processDefinitionKey": 0,
  "processName": "",
  "processPriority": 0,
  "resource": "",
  "resourceName": "",
  "usageType": 0,
  "version": 0,
  "waitForResponse": false
}

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

No example specified for this content type

get-process-definition-detail-list

GET

https://dg-sandbox.dgpays.com/bpm-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.

get-process-definition-detail-list › path Parameters

id

string · uuid · required

get-process-definition-detail-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-process-definition-detail-list › Responses

object[]

Array of catalog-declared response records.

deploymentTime

string · date-time

id

string · uuid

processDefinitionKey

integer · int64

resourceName

string

versionNo

integer · int32

xmlResource

string

GET/process-definitions/{id}/details

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id/details

Example Responses

[
  {
    "deploymentTime": "2024-08-25T15:00:00Z",
    "id": "00000000-0000-0000-0000-000000000000",
    "processDefinitionKey": 0,
    "resourceName": "resourceName",
    "versionNo": 0,
    "xmlResource": "xmlResource"
  }
]

application/json

create-process-definition-detail

POST

https://dg-sandbox.dgpays.com/bpm-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

Field	Name on the wire	Declared type	Nullable
`Id`	`id`	`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_22`	400	`PROCESS_DEFINITION_DETAIL_ALREADY_EXISTS`	Process definition detail already exists.

create-process-definition-detail › path Parameters

id

string · uuid · required

create-process-definition-detail › Request Body

processDefinitionKey

integer · int64 · required

processName

string · required

resource

string · required

resourceName

string · required

usageType

integer · int32 · required

Permitted values — validated against the usage_type parameter.

Value	Meaning
`1`	Service
`2`	BPM
`4`	Rule
`3`	Formula
`5`	Distributed Query
`6`	Keycloak Service
`7`	Camunda Service
`8`	Task List

Permitted values — validated against the usage_type parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Service`	en: Service · ar: خدمة
`2`	`BPM`	en: BPM · ar: معدل ضربات القلب
`4`	`Rule`	en: Rule · ar: قاعدة
`3`	`Formula`	en: Formula · ar: الصيغة
`5`	`DistributedQuery`	en: Distributed Query · ar: استعلام موزع
`6`	`Keycloak`	en: Keycloak Service · ar: خدمة كي-كلاوك
`7`	`Camunda`	en: Camunda Service · ar: خدمة كاموندা
`8`	`TaskList`	en: Task List · ar: قائمة المهام

version

integer · int32 · required

waitForResponse

boolean · required

editedResource

string

create-process-definition-detail › Responses

Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.

Body shape declared by the exact route registration for the catalog's 200 response.

id

string · uuid

Identifier returned by the command.

POST/process-definitions/{id}/details

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id/details \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "editedResource": "",
  "processDefinitionKey": 0,
  "processName": "",
  "resource": "",
  "resourceName": "",
  "usageType": 0,
  "version": 0,
  "waitForResponse": false
}'

Example Request Body

{
  "editedResource": "",
  "processDefinitionKey": 0,
  "processName": "",
  "resource": "",
  "resourceName": "",
  "usageType": 0,
  "version": 0,
  "waitForResponse": false
}

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000"
}

application/json

update-process-definition-detail

PUT

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

/process-definitions/{id}/details/{processDefinitionDetailId}

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_21`	400	`PROCESS_DEFINITION_IS_NOT_FOUND`	Process definition cannot be found.
`ERR_BPM_23`	400	`PROCESS_DEFINITION_DETAIL_IS_NOT_FOUND`	Process definition detail cannot be found.

update-process-definition-detail › path Parameters

id

string · uuid · required

processDefinitionDetailId

string · uuid · required

update-process-definition-detail › Request Body

waitForResponse

boolean · required

update-process-definition-detail › Responses

No data returned

PUT/process-definitions/{id}/details/{processDefinitionDetailId}

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id/details/:processDefinitionDetailId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "waitForResponse": false
}'

Example Request Body

{
  "waitForResponse": false
}

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

No example specified for this content type

get-process-element-list

GET

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

/process-definitions/{id}/details/{processDefinitionDetailId}/elements

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`ElementId`	`string`	no
`BpmnElementType`	`string`	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_23`	400	`PROCESS_DEFINITION_DETAIL_IS_NOT_FOUND`	Process definition detail cannot be found.

get-process-element-list › path Parameters

id

string · uuid · required

processDefinitionDetailId

string · uuid · required

get-process-element-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-process-element-list › Responses

object[]

Array of catalog-declared response records.

bpmnElementType

string

elementId

string

id

string · uuid

GET/process-definitions/{id}/details/{processDefinitionDetailId}/elements

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id/details/:processDefinitionDetailId/elements

Example Responses

[
  {
    "bpmnElementType": "bpmnElementType",
    "elementId": "elementId",
    "id": "00000000-0000-0000-0000-000000000000"
  }
]

application/json

create-process-element

POST

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

/process-definitions/{id}/details/{processDefinitionDetailId}/elements

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

Response body, read from the service source

Field	Name on the wire	Declared type	Nullable
`Id`	`id`	`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_23`	400	`PROCESS_DEFINITION_DETAIL_IS_NOT_FOUND`	Process definition detail cannot be found.

create-process-element › path Parameters

id

string · uuid · required

processDefinitionDetailId

string · uuid · required

create-process-element › Request Body

bpmnElementType

string · required

elementId

string · required

create-process-element › Responses

Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.

Body shape declared by the exact route registration for the catalog's 200 response.

id

string · uuid

Identifier returned by the command.

POST/process-definitions/{id}/details/{processDefinitionDetailId}/elements

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id/details/:processDefinitionDetailId/elements \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "bpmnElementType": "",
  "elementId": ""
}'

Example Request Body

{
  "bpmnElementType": "",
  "elementId": ""
}

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000"
}

application/json

create-process-element-with-details

POST

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

/process-definitions/{id}/details/{processDefinitionDetailId}/elements/details

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_21`	400	`PROCESS_DEFINITION_IS_NOT_FOUND`	Process definition cannot be found.
`ERR_BPM_23`	400	`PROCESS_DEFINITION_DETAIL_IS_NOT_FOUND`	Process definition detail cannot be found.

create-process-element-with-details › path Parameters

id

string · uuid · required

processDefinitionDetailId

string · uuid · required

create-process-element-with-details › Request Body

object[] · required

create-process-element-with-details › Responses

No data returned

POST/process-definitions/{id}/details/{processDefinitionDetailId}/elements/details

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id/details/:processDefinitionDetailId/elements/details \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "elements": [
    {}
  ]
}'

Example Request Body

{
  "elements": [
    {}
  ]
}

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

No example specified for this content type

get-process-element-flow-list

GET

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

/process-definitions/{id}/details/{processDefinitionDetailId}/elements/{processElementId}/flows

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

Field	Declared type	Nullable
`Id`	`Guid?`	yes
`FromProcessElementId`	`Guid?`	yes
`ToProcessElementId`	`Guid?`	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.
`ERR_BPM_23`	400	`PROCESS_DEFINITION_DETAIL_IS_NOT_FOUND`	Process definition detail cannot be found.
`ERR_BPM_34`	400	`PROCESS_ELEMENT_NOT_FOUND`	Process Element cannot be found.

get-process-element-flow-list › path Parameters

id

string · uuid · required

processDefinitionDetailId

string · uuid · required

processElementId

string · uuid · required

get-process-element-flow-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-process-element-flow-list › Responses

object[]

Array of catalog-declared response records.

fromProcessElementId

string · uuid

id

string · uuid

toProcessElementId

string · uuid

GET/process-definitions/{id}/details/{processDefinitionDetailId}/elements/{processElementId}/flows

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id/details/:processDefinitionDetailId/elements/:processElementId/flows

Example Responses

[
  {
    "fromProcessElementId": "00000000-0000-0000-0000-000000000000",
    "id": "00000000-0000-0000-0000-000000000000",
    "toProcessElementId": "00000000-0000-0000-0000-000000000000"
  }
]

application/json

create-process-element-flow

POST

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

/process-definitions/{id}/details/{processDefinitionDetailId}/elements/{processElementId}/flows

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

Response body, read from the service source

Field	Name on the wire	Declared type	Nullable
`Id`	`id`	`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_23`	400	`PROCESS_DEFINITION_DETAIL_IS_NOT_FOUND`	Process definition detail cannot be found.
`ERR_BPM_34`	400	`PROCESS_ELEMENT_NOT_FOUND`	Process Element cannot be found.

create-process-element-flow › path Parameters

id

string · uuid · required

processDefinitionDetailId

string · uuid · required

processElementId

string · uuid · required

create-process-element-flow › Request Body

fromProcessElementId

string · uuid · required

toProcessElementId

string · uuid · required

create-process-element-flow › Responses

Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.

Body shape declared by the exact route registration for the catalog's 200 response.

id

string · uuid

Identifier returned by the command.

POST/process-definitions/{id}/details/{processDefinitionDetailId}/elements/{processElementId}/flows

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id/details/:processDefinitionDetailId/elements/:processElementId/flows \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "fromProcessElementId": "",
  "toProcessElementId": ""
}'

Example Request Body

{
  "fromProcessElementId": "",
  "toProcessElementId": ""
}

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000"
}

application/json

get-process-element-property-list

GET

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

/process-definitions/{id}/details/{processDefinitionDetailId}/elements/{processElementId}/properties

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`PropertyKey`	`string`	no
`PropertyValue`	`string`	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_23`	400	`PROCESS_DEFINITION_DETAIL_IS_NOT_FOUND`	Process definition detail cannot be found.
`ERR_BPM_34`	400	`PROCESS_ELEMENT_NOT_FOUND`	Process Element cannot be found.

get-process-element-property-list › path Parameters

id

string · uuid · required

processDefinitionDetailId

string · uuid · required

processElementId

string · uuid · required

get-process-element-property-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-process-element-property-list › Responses

object[]

Array of catalog-declared response records.

id

string · uuid

propertyKey

string

propertyValue

string

GET/process-definitions/{id}/details/{processDefinitionDetailId}/elements/{processElementId}/properties

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id/details/:processDefinitionDetailId/elements/:processElementId/properties

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "propertyKey": "propertyKey",
    "propertyValue": "propertyValue"
  }
]

application/json

create-process-element-property

POST

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

/process-definitions/{id}/details/{processDefinitionDetailId}/elements/{processElementId}/properties

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

Response body, read from the service source

Field	Name on the wire	Declared type	Nullable
`Id`	`id`	`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_23`	400	`PROCESS_DEFINITION_DETAIL_IS_NOT_FOUND`	Process definition detail cannot be found.
`ERR_BPM_34`	400	`PROCESS_ELEMENT_NOT_FOUND`	Process Element cannot be found.

create-process-element-property › path Parameters

id

string · uuid · required

processDefinitionDetailId

string · uuid · required

processElementId

string · uuid · required

create-process-element-property › Request Body

propertyKey

string · required

propertyValue

string · required

create-process-element-property › Responses

Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.

Body shape declared by the exact route registration for the catalog's 200 response.

id

string · uuid

Identifier returned by the command.

POST/process-definitions/{id}/details/{processDefinitionDetailId}/elements/{processElementId}/properties

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id/details/:processDefinitionDetailId/elements/:processElementId/properties \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "propertyKey": "",
  "propertyValue": ""
}'

Example Request Body

{
  "propertyKey": "",
  "propertyValue": ""
}

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000"
}

application/json

get-process-definition-stopper-list

GET

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

/process-definitions/{id}/stoppers

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`ErrorCode`	`string`	no
`IsProcessStop`	`bool`	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.

get-process-definition-stopper-list › path Parameters

id

string · uuid · required

get-process-definition-stopper-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-process-definition-stopper-list › Responses

Success. The catalog declares no response fields for this operation. It returns a collection of records — but the record's fields are not declared.

No data returned

GET/process-definitions/{id}/stoppers

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id/stoppers

Example Responses

No example specified for this content type

create-process-definition-stopper

POST

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

/process-definitions/{id}/stoppers

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

Response body, read from the service source

Field	Name on the wire	Declared type	Nullable
`Id`	`id`	`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_52`	400	`ERROR_CODE_CANNOT_BE_EMPTY`	not published in this snapshot

create-process-definition-stopper › path Parameters

id

string · uuid · required

create-process-definition-stopper › Request Body

errorCode

string · required

isProcessStop

boolean · required

create-process-definition-stopper › Responses

Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.

Body shape declared by the exact route registration for the catalog's 200 response.

id

string · uuid

Identifier returned by the command.

POST/process-definitions/{id}/stoppers

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id/stoppers \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "errorCode": "",
  "isProcessStop": false
}'

Example Request Body

{
  "errorCode": "",
  "isProcessStop": false
}

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000"
}

application/json

get-process-definition-stopper-by-id

GET

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

/process-definitions/{id}/stoppers/{processDefinitionStopperId}

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

Field	Declared type	Nullable
`Id`	`Guid`	no
`ErrorCode`	`string`	no
`IsProcessStop`	`bool`	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_53`	400	`PROCESS_DEFINITION_STOPPER_ID_NOT_FOUND`	not published in this snapshot

get-process-definition-stopper-by-id › path Parameters

id

string · uuid · required

processDefinitionStopperId

string · uuid · required

get-process-definition-stopper-by-id › Responses

errorCode

string

id

string · uuid

isProcessStop

boolean

GET/process-definitions/{id}/stoppers/{processDefinitionStopperId}

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id/stoppers/:processDefinitionStopperId

Example Responses

{
  "errorCode": "errorCode",
  "id": "00000000-0000-0000-0000-000000000000",
  "isProcessStop": true
}

application/json

update-process-definition-stopper

PUT

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

/process-definitions/{id}/stoppers/{processDefinitionStopperId}

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
`ERR_BPM_52`	400	`ERROR_CODE_CANNOT_BE_EMPTY`

update-process-definition-stopper › path Parameters

id

string · uuid · required

processDefinitionStopperId

string · uuid · required

update-process-definition-stopper › Request Body

errorCode

string · required

isProcessStop

boolean · required

update-process-definition-stopper › Responses

No data returned

PUT/process-definitions/{id}/stoppers/{processDefinitionStopperId}

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id/stoppers/:processDefinitionStopperId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "errorCode": "",
  "isProcessStop": false
}'

Example Request Body

{
  "errorCode": "",
  "isProcessStop": false
}

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

No example specified for this content type

delete-process-definition-stopper

DELETE

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

/process-definitions/{id}/stoppers/{processDefinitionStopperId}

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

delete-process-definition-stopper › path Parameters

id

string · uuid · required

processDefinitionStopperId

string · uuid · required

delete-process-definition-stopper › Responses

No data returned

DELETE/process-definitions/{id}/stoppers/{processDefinitionStopperId}

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id/stoppers/:processDefinitionStopperId \
  --request DELETE

Example Responses

No example specified for this content type

get-process-user-task-list

GET

https://dg-sandbox.dgpays.com/bpm-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.

get-process-user-task-list › path Parameters

id

string · uuid · required

get-process-user-task-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-process-user-task-list › Responses

object[]

Array of catalog-declared response records.

elementId

string

id

string · uuid

organizationApprovementType

integer · int32

Permitted values — validated against the organization_approval_type parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Only Users Organization Approve`	en: Only Users Organization can Approve · ar: فقط منظمة المستخدمين يمكنها الموافقة
`2`	`Any User Approve`	en: Any User can Approve · ar: أي مستخدم يمكنه الموافقة

processDefinitionId

string · uuid

validationSchema

string

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

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id/user-tasks

Example Responses

[
  {
    "elementId": "elementId",
    "id": "00000000-0000-0000-0000-000000000000",
    "organizationApprovementType": 0,
    "processDefinitionId": "00000000-0000-0000-0000-000000000000",
    "validationSchema": "validationSchema"
  }
]

application/json

create-process-user-task

POST

https://dg-sandbox.dgpays.com/bpm-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

Field	Name on the wire	Declared type	Nullable
`Id`	`id`	`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.

create-process-user-task › path Parameters

id

string · uuid · required

create-process-user-task › Request Body

elementId

string · required

organizationApprovementType

integer · int32 · required

Permitted values — validated against the organization_approval_type parameter.

Value	Meaning
`1`	Only Users Organization can Approve
`2`	Any User can Approve

Permitted values — validated against the organization_approval_type parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Only Users Organization Approve`	en: Only Users Organization can Approve · ar: فقط منظمة المستخدمين يمكنها الموافقة
`2`	`Any User Approve`	en: Any User can Approve · ar: أي مستخدم يمكنه الموافقة

validationSchema

string

create-process-user-task › Responses

Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.

Body shape declared by the exact route registration for the catalog's 200 response.

id

string · uuid

Identifier returned by the command.

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

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id/user-tasks \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "elementId": "",
  "organizationApprovementType": 0,
  "validationSchema": ""
}'

Example Request Body

{
  "elementId": "",
  "organizationApprovementType": 0,
  "validationSchema": ""
}

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000"
}

application/json

update-user-tasks-status-except-ids

PUT

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

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

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

Response body, read from the service source

The route returns List<string>, a scalar rather than an object. There is no field tree below because there are no fields: the body is a JSON array of JSON strings. This is a complete answer read from the declaration, not a gap.

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.

update-user-tasks-status-except-ids › path Parameters

id

string · uuid · required

update-user-tasks-status-except-ids › Request Body

userTaskIds

string[] · required

update-user-tasks-status-except-ids › Responses

Success. The catalog declares no response fields for this operation. It returns a collection of records — but the record's fields are not declared.

No data returned

PUT/process-definitions/{id}/user-tasks/change-statuses

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id/user-tasks/change-statuses \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "userTaskIds": [
    ""
  ]
}'

Example Request Body

{
  "userTaskIds": [
    ""
  ]
}

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

No example specified for this content type

get-process-user-task-by-id

GET

https://dg-sandbox.dgpays.com/bpm-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.

get-process-user-task-by-id › path Parameters

id

string · uuid · required

processUserTaskId

string · uuid · required

get-process-user-task-by-id › Responses

elementId

string

id

string · uuid

organizationApprovementType

integer · int32

Permitted values — validated against the organization_approval_type parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Only Users Organization Approve`	en: Only Users Organization can Approve · ar: فقط منظمة المستخدمين يمكنها الموافقة
`2`	`Any User Approve`	en: Any User can Approve · ar: أي مستخدم يمكنه الموافقة

processDefinitionId

string · uuid

validationSchema

string

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

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id/user-tasks/:processUserTaskId

Example Responses

{
  "elementId": "elementId",
  "id": "00000000-0000-0000-0000-000000000000",
  "organizationApprovementType": 0,
  "processDefinitionId": "00000000-0000-0000-0000-000000000000",
  "validationSchema": "validationSchema"
}

application/json

update-process-user-task

PUT

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

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

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_21`	400	`PROCESS_DEFINITION_IS_NOT_FOUND`	Process definition cannot be found.

update-process-user-task › path Parameters

id

string · uuid · required

processUserTaskId

string · uuid · required

update-process-user-task › Request Body

elementId

string · required

organizationApprovementType

integer · int32 · required

Permitted values — validated against the organization_approval_type parameter.

Value	Meaning
`1`	Only Users Organization can Approve
`2`	Any User can Approve

Permitted values — validated against the organization_approval_type parameter. The service rejects any other value.

Value	Token	Labels
`1`	`Only Users Organization Approve`	en: Only Users Organization can Approve · ar: فقط منظمة المستخدمين يمكنها الموافقة
`2`	`Any User Approve`	en: Any User can Approve · ar: أي مستخدم يمكنه الموافقة

validationSchema

string

update-process-user-task › Responses

No data returned

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

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id/user-tasks/:processUserTaskId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "elementId": "",
  "organizationApprovementType": 0,
  "validationSchema": ""
}'

Example Request Body

{
  "elementId": "",
  "organizationApprovementType": 0,
  "validationSchema": ""
}

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

No example specified for this content type

delete-process-user-task

DELETE

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

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

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_21`	400	`PROCESS_DEFINITION_IS_NOT_FOUND`	Process definition cannot be found.

delete-process-user-task › path Parameters

id

string · uuid · required

processUserTaskId

string · uuid · required

delete-process-user-task › Responses

No data returned

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

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id/user-tasks/:processUserTaskId \
  --request DELETE

Example Responses

No example specified for this content type

get-process-user-task-action-map-list

GET

https://dg-sandbox.dgpays.com/bpm-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.

get-process-user-task-action-map-list › path Parameters

id

string · uuid · required

processUserTaskId

string · uuid · required

get-process-user-task-action-map-list › query Parameters

object

orderBy

string

orderSort

string

pageIndex

integer · int32

pageSize

integer · int32

get-process-user-task-action-map-list › Responses

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

No data returned

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

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id/user-tasks/:processUserTaskId/action-maps

Example Responses

No example specified for this content type

create-process-user-task-action-map

POST

https://dg-sandbox.dgpays.com/bpm-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

Field	Name on the wire	Declared type	Nullable
`Id`	`id`	`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.

create-process-user-task-action-map › path Parameters

id

string · uuid · required

processUserTaskId

string · uuid · required

create-process-user-task-action-map › Request Body

actionId

string · uuid · required

create-process-user-task-action-map › Responses

Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.

Body shape declared by the exact route registration for the catalog's 200 response.

id

string · uuid

Identifier returned by the command.

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

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id/user-tasks/:processUserTaskId/action-maps \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "actionId": ""
}'

Example Request Body

{
  "actionId": ""
}

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000"
}

application/json

delete-process-user-task-action-map-by-action-id

DELETE

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

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

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_21`	400	`PROCESS_DEFINITION_IS_NOT_FOUND`	Process definition cannot be found.
`ERR_BPM_64`	400	`PROCESS_USER_TASK_ACTION_NOT_FOUND`	Process user task action record cannot be found

delete-process-user-task-action-map-by-action-id › path Parameters

id

string · uuid · required

processUserTaskId

string · uuid · required

actionId

string · uuid · required

delete-process-user-task-action-map-by-action-id › Responses

No data returned

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

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id/user-tasks/:processUserTaskId/action-maps/by-action-id/:actionId \
  --request DELETE

Example Responses

No example specified for this content type

update-process-user-task-action-map

PUT

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

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

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_21`	400	`PROCESS_DEFINITION_IS_NOT_FOUND`	Process definition cannot be found.

update-process-user-task-action-map › path Parameters

id

string · uuid · required

processUserTaskId

string · uuid · required

processUserTaskActionMapId

string · uuid · required

update-process-user-task-action-map › Request Body

actionId

string · uuid · required

update-process-user-task-action-map › Responses

No data returned

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

curl https://dg-sandbox.dgpays.com/bpm-service/process-definitions/:id/user-tasks/:processUserTaskId/action-maps/:processUserTaskActionMapId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --data '{
  "actionId": ""
}'

Example Request Body

{
  "actionId": ""
}

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

No example specified for this content type

process-definition-drafts process-instances