Get Process Definition
Overview
Retrieve a process definition by its name.
Endpoint
GET /api/processdefinition/byName
Use the service origin described in Getting started. The path above already includes /api.
Authentication
Send the access token obtained from Get Access Token in the Authorization header. Access is limited by the authenticated account’s permissions.
Request headers
Accept: application/json
Authorization: Bearer ACCESS_TOKEN
Query parameters
| Parameter | Type | Requirement | Description |
|---|---|---|---|
name | string | Required | Published process name. |
Request example
The following example uses cURL in a POSIX shell. Replace example credentials and IDs before running it. Replace the AI Command Center origin with your deployment address.
curl --request GET \
--url 'https://command-center.example.com/api/processdefinition/byName?name=Expense-Report-Approval' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ACCESS_TOKEN'
Response
Successful status: 200 OK.
The following is an illustrative response with synthetic contact and credential values. Arrays are shortened to one representative item.
{
"permission": "Owner",
"recycled": false,
"processId": 19,
"tenantId": 1,
"processGuid": "030a3c01-42a4-4dff-967d-c79ddc824f0d",
"processType": "BPA",
"documentId": null,
"name": "Expense-Report-Approval",
"publishedDate": "2024-03-12T06:40:24.713511",
"version": "1.0.0.15",
"description": "Expense Report Approval",
"arguments": null,
"logLevel": "Information",
"category": "Expense Report Approval",
"isCheckedOut": false,
"checkedOutBy": "",
"isDraft": false,
"isPublished": true,
"isApplication": true,
"created": "2024-01-03T09:10:22.815817",
"modified": "2024-04-08T12:53:42.810035",
"createdBy": "Sample User",
"modifiedBy": "Sample User"
}
Response fields
The table describes selected fields in the response. Types reflect the example; this is not an exhaustive schema or nullability contract.
| Field | Example type | Description |
|---|---|---|
permission | string | Access level reported for the authenticated user. |
processId | integer | ID of the process definition. |
tenantId | integer | ID of the tenant. |
processGuid | string | GUID identifying the process definition. |
arguments | null | Process or task arguments, when present. |
Errors
Endpoint-specific error statuses and response bodies are not yet documented. See Usage and troubleshooting for general handling guidance.