deploy-process

Operations addressed under /deploy-process — 2 operations.

deploy-process-request

POST

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

/deploy-process

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

deploy-process-request › Request Body

canPreviousUserApprove

boolean · required

canStarterUserApprove

boolean · required

operationType

integer · int32 · required

path

string · required

resourceContent

string · required

resourceName

string · required

tenantId

string · uuid · required

object[] · 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: قائمة المهام

waitForResponse

boolean · required

deploy-process-request › 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.

key

integer · int64

object[]

POST/deploy-process

curl https://dg-sandbox.dgpays.com/bpm-service/deploy-process \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "canPreviousUserApprove": false,
  "canStarterUserApprove": false,
  "operationType": 0,
  "path": "",
  "resourceContent": "",
  "resourceName": "",
  "tenantId": "",
  "translations": [
    {
      "languageCode": "",
      "name": ""
    }
  ],
  "usageType": 0,
  "waitForResponse": false
}'

Example Request Body

{
  "canPreviousUserApprove": false,
  "canStarterUserApprove": false,
  "operationType": 0,
  "path": "",
  "resourceContent": "",
  "resourceName": "",
  "tenantId": "",
  "translations": [
    {
      "languageCode": "",
      "name": ""
    }
  ],
  "usageType": 0,
  "waitForResponse": false
}

json

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

application/json

Example Responses

{
  "key": 0,
  "processes": [
    {
      "bpmnProcessId": "bpmnProcessId",
      "processDefinitionKey": 0,
      "resourceName": "resourceName",
      "version": 0
    }
  ]
}

json

application/json

deploy-process-by-process-definition-id

POST

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

/deploy-process/by-process-definition-id/{processDefinitionId}

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

Field	Declared type	Nullable
`BpmnProcessId`	`string`	no
`ProcessDefinitionKey`	`long`	no
`Version`	`int`	no
`Resource`	`string`	no
`EditedResource`	`string`	no
`Elements`	`IEnumerable<Element>` (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_38`	400	`DEPLOY_HAS_ERROR`	Deploy has error. Error: `{0}`

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

processDefinitionId

string · uuid · required

deploy-process-by-process-definition-id › Responses

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

No data returned

deploy-decision dms-items

BPM

deploy-process

Operations addressed under /deploy-process — 2 operations.

deploy-process-request

POST

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

/deploy-process

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

deploy-process-request › Request Body

canPreviousUserApprove

boolean · required

canStarterUserApprove

boolean · required

operationType

integer · int32 · required

path

string · required

resourceContent

string · required

resourceName

string · required

tenantId

string · uuid · required

object[] · 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: قائمة المهام

waitForResponse

boolean · required

deploy-process-request › Responses

key

integer · int64

object[]

POST/deploy-process

curl https://dg-sandbox.dgpays.com/bpm-service/deploy-process \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "canPreviousUserApprove": false,
  "canStarterUserApprove": false,
  "operationType": 0,
  "path": "",
  "resourceContent": "",
  "resourceName": "",
  "tenantId": "",
  "translations": [
    {
      "languageCode": "",
      "name": ""
    }
  ],
  "usageType": 0,
  "waitForResponse": false
}'

Example Request Body

{
  "canPreviousUserApprove": false,
  "canStarterUserApprove": false,
  "operationType": 0,
  "path": "",
  "resourceContent": "",
  "resourceName": "",
  "tenantId": "",
  "translations": [
    {
      "languageCode": "",
      "name": ""
    }
  ],
  "usageType": 0,
  "waitForResponse": false
}

json

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

application/json

Example Responses

{
  "key": 0,
  "processes": [
    {
      "bpmnProcessId": "bpmnProcessId",
      "processDefinitionKey": 0,
      "resourceName": "resourceName",
      "version": 0
    }
  ]
}

json

application/json

deploy-process-by-process-definition-id

POST

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

/deploy-process/by-process-definition-id/{processDefinitionId}

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

Field	Declared type	Nullable
`BpmnProcessId`	`string`	no
`ProcessDefinitionKey`	`long`	no
`Version`	`int`	no
`Resource`	`string`	no
`EditedResource`	`string`	no
`Elements`	`IEnumerable<Element>` (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_38`	400	`DEPLOY_HAS_ERROR`	Deploy has error. Error: `{0}`

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

processDefinitionId

string · uuid · required

deploy-process-by-process-definition-id › Responses

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

No data returned

deploy-decision dms-items