Skip to main content

Get Process Definition

Overview​

Getting Process Definition by providing the Process Name.

URL:​

api/processdefinition/byName?name=

Method: GET​

Request Header:​

{ "accept": "'*/*'", "Authorization": Bearer ACCESS_TOKEN }

Query Parameter:​

  • name=Expense-Report-Approval
  http://<Control Room server>/api/processdefinition/byName?name=Expense-Report-Approval

Response:​

  • Status: 200 OK

  • Body:

       {
         "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": "2#demouser1 1",
         "modifiedBy": "2#demouser1 1"
       }

  • Header:

       {
         content-length: 607 
         referrer-policy: no-referrer 
         x-content-type-options: nosniff 
         x-xss-protection: 1; mode=block 
       }