Activate an operating process
curl --request POST \
--url https://useorgx.com/api/v1/operating-processes/{processId}/activate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"workspace_id": "98608ef9-3fc8-4e9a-8ae4-5f80e214cfab",
"expected_aggregate_version": 0
}
'const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
workspace_id: '98608ef9-3fc8-4e9a-8ae4-5f80e214cfab',
expected_aggregate_version: 0
})
};
fetch('https://useorgx.com/api/v1/operating-processes/{processId}/activate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://useorgx.com/api/v1/operating-processes/{processId}/activate"
payload = {
"workspace_id": "98608ef9-3fc8-4e9a-8ae4-5f80e214cfab",
"expected_aggregate_version": 0
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"processId": "75e02472-b242-4af9-845d-436c040749ed",
"transition": "confirm",
"ledger": {
"eventId": "5e0e63b4-ae40-4cad-8d31-ab19a5622e4c",
"aggregateVersion": 1,
"eventHash": "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"duplicate": false,
"payloadDigest": "sha256:bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
},
"aggregateVersion": 1
},
"meta": {
"apiVersion": "1",
"workspaceId": "09707fa5-aaae-4493-8a23-827111000f89"
}
}{
"data": {
"processId": "75e02472-b242-4af9-845d-436c040749ed",
"transition": "confirm",
"ledger": {
"eventId": "5e0e63b4-ae40-4cad-8d31-ab19a5622e4c",
"aggregateVersion": 1,
"eventHash": "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"duplicate": false,
"payloadDigest": "sha256:bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
},
"aggregateVersion": 1
},
"meta": {
"apiVersion": "1",
"workspaceId": "09707fa5-aaae-4493-8a23-827111000f89"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docsUrl": "<string>",
"retryAfter": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docsUrl": "<string>",
"retryAfter": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docsUrl": "<string>",
"retryAfter": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docsUrl": "<string>",
"retryAfter": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docsUrl": "<string>",
"retryAfter": 123
}
}Operating processes
Activate an operating process
Activate a confirmed process so new work can flow through it.
POST
/
operating-processes
/
{processId}
/
activate
Activate an operating process
curl --request POST \
--url https://useorgx.com/api/v1/operating-processes/{processId}/activate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"workspace_id": "98608ef9-3fc8-4e9a-8ae4-5f80e214cfab",
"expected_aggregate_version": 0
}
'const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
workspace_id: '98608ef9-3fc8-4e9a-8ae4-5f80e214cfab',
expected_aggregate_version: 0
})
};
fetch('https://useorgx.com/api/v1/operating-processes/{processId}/activate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://useorgx.com/api/v1/operating-processes/{processId}/activate"
payload = {
"workspace_id": "98608ef9-3fc8-4e9a-8ae4-5f80e214cfab",
"expected_aggregate_version": 0
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"processId": "75e02472-b242-4af9-845d-436c040749ed",
"transition": "confirm",
"ledger": {
"eventId": "5e0e63b4-ae40-4cad-8d31-ab19a5622e4c",
"aggregateVersion": 1,
"eventHash": "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"duplicate": false,
"payloadDigest": "sha256:bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
},
"aggregateVersion": 1
},
"meta": {
"apiVersion": "1",
"workspaceId": "09707fa5-aaae-4493-8a23-827111000f89"
}
}{
"data": {
"processId": "75e02472-b242-4af9-845d-436c040749ed",
"transition": "confirm",
"ledger": {
"eventId": "5e0e63b4-ae40-4cad-8d31-ab19a5622e4c",
"aggregateVersion": 1,
"eventHash": "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"duplicate": false,
"payloadDigest": "sha256:bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
},
"aggregateVersion": 1
},
"meta": {
"apiVersion": "1",
"workspaceId": "09707fa5-aaae-4493-8a23-827111000f89"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docsUrl": "<string>",
"retryAfter": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docsUrl": "<string>",
"retryAfter": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docsUrl": "<string>",
"retryAfter": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docsUrl": "<string>",
"retryAfter": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"requestId": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docsUrl": "<string>",
"retryAfter": 123
}
}Authorizations
bearerAuthcookieAuth
OrgX API key, sent as Authorization: Bearer oxk_...
Headers
Workspace-scoped retry key for safe mutation replay.
Required string length:
1 - 200Pattern:
^[A-Za-z0-9][A-Za-z0-9._:/-]{0,199}$Path Parameters
Body
application/json
