Endpoints in the REST API
The Case REST APIs provide a standardized interface for managing the lifecycle of service cases and related tasks. They support creating, retrieving, updating, and listing cases, as well as managing case tasks.
- Before you begin
- Additional information
- Retrieve a case - API V1
- Retrieve a case – API V3
- List cases – API V1
- List cases – API V3
- Create a case – API V1
- Create a case – API V2
- Create a case – API V3
- Update a case – API V1
- Update a case – API V2
- List case tasks – API V1
- Retrieve a case task – API V1
- Create a task – API V1
- Create a task– API V2
- Update a task – API V1
- Update a task – API V2
Before you begin
Users require the following role to use the APIs:
Roles required: Case Agent
Authentication: JWT authentication
Additional information
The API uses JSON for request and response bodies. For operations with attachments, requests must be sent as multipart or form-data, with one part containing the JSON payload and additional parts containing the files. The following headers are common for all requests:
| Name | Description |
| Authorization | Contains the authentication credentials for HTTP authentication. Example: AR-JWT={{token}} |
| X-Requested-By | Example: XMLHttpRequest |
| Accept | Data format of the response body. Supported type: application/json Example: application/json |
Retrieve a case - API V1
To retrieve case details information.
Additional headers
| Name | Description |
| Content-Type | application/json |
Endpoint
Path parameters
| Name | Type | Description |
| id | String | A case GUID, couldn't be missed or blank. |
Query parameters
None
Response
| Status code | Description |
| 200 OK | { "id": "AGGADGG8ECDC1AS3VXZXS3VXZXECUM", "displayId": "CASE-0000000002", "summary": "Spot Bonus Request", "createdBy": "tadmin", "createdDate": "2024-05-22T11:45:33.000Z", "modifiedBy": "tadmin", "modifiedDate": "2024-05-22T11:46:26.000Z", "assignee": "Peter", "assigneeFullName": "Peter Kahn", "template": "Spot Bonus Request", "description": "<p>Verify if the employee is eligible for a spot bonus and if so, please register in the HCM system.</p>", "priority": 4000, "priorityLabel": "Low", "requester": "hhaas", "contact": null, "company": "Petramco", "categoryTier1": "Projectors", "categoryTier2": null, "categoryTier3": null, "categoryTier4": null, "assignedCompany": "Petramco", "businessUnit": "HR Support", "supportOrganization": "HR Support", "supportGroup": "Compensation and Benefits", "site": "Aichi", "region": "Asia-Pac", "origin": "Agent", "statusReason": null, "flowset": null, "assigneeGuid": "AGGCEME2HPULZAOQMLOFOPQ96MRPDZ", "serviceRequestGuid": null, "serviceRequestId": null, "dynamicData": { "What is your Business Unit?": "IT", "What is the Amount?": "100", "Date of Travel": 1715348747, "Full Name of Employee Nominated": "John" }, "questions": [ { "questionType": 1000, "answer": "John", "questionId": "507df97e-b82e-f037-b4fb-fe1627f2f787", "label": "Full Name of Employee Nominated" }, { "questionType": 1000, "answer": "100", "questionId": "4bb23fad-f856-ae86-db55-b054187dda0d", "label": "What is the amount?" }, { "questionType": 3000, "answer": "2024-05-10", "questionId": "97ecfc01-dd71-7c6b-3825-5fbc763fc2f6", "label": "Date of Travel" }, { "questionType": 1000, "answer": "IT", "label": "What is your Business Unit?" } ], "label": null, "targetDate": null, "lineOfBusiness": "Human Resource", "siteGroup": "Engineering", "externalSystemRequestId": null, "externalSystemDetails": null, "resolutionDescription": null, "resolutionCode": null, "status": "Assigned" } |
| 404 | Not found |
| 400 | Bad request |
| 500 | Internal Server Error |
Retrieve a case – API V3
To retrieve case details information.
Query a case by ID and control which standard, extension, or dynamic fields are included in the response.
Additional headers
| Name | Description |
| Content-Type | application/json |
Endpoint
Path parameters
| Name | Type | Description |
| id | String | A case GUID, couldn't be missed or blank. |
Query parameters
None
Request Body parameters (JSON)
| Property Name | Type | Description |
|---|---|---|
| includeFieldData | Boolean | If true, includes values from Case RD (Record Definition) fields. |
| includeExtensionFieldData | Boolean | If true, includes values from Case Extension RD fields. |
| includeDynamicData | Boolean | If true, includes dynamic fields such as runtime-calculated or workflow-populated values. |
| includeResolvedFieldData | Boolean | If true, includes resolved values for system fields such as Requester and Contact (translates GUIDs/login names to full names). |
| casePropertySelection | String | Comma-separated string. Specifies which Case RD field IDs (e.g., 1,379,450000010) should be included in the response. |
| caseExtensionPropertySelection | String | Comma-separated string. Specifies which Case Extension RD field IDs should be included in the response. |
Response
| Status code | Description |
| 200 | { "displayId": "CASE-0000000214", "id": "AGGADGG8ECDC2AS6FQTUS6FQTUP9CX", "dynamicData": [ { "questionType": 1000, "questionTypeLabel": "TEXT", "answer": "100", "questionId": "4bb23fad-f856-ae86-db55-b054187dda0d", "dataProviderUserRole": "Requester", "taskOnly": false, "questionScope": "Global", "label": "What is the amount?", "question": "What is the amount?" } ], "extensionFieldData": [ { "id": "536870915", "name": "E_DateTime", "value": "2024-07-11T00:25:00.000Z", "valueByLocale": null }, { "id": "1", "name": "Display ID", "value": "000000000000001", "valueByLocale": null }, { "id": "536870916", "name": "E_Date", "value": "2024-07-04", "valueByLocale": null }, { "id": "536870917", "name": "E_Boolean", "value": 0, "valueByLocale": null }, { "id": "536870913", "name": "E_Text", "value": "Extension Field Value", "valueByLocale": null }, { "id": "536870914", "name": "E_Time", "value": "12:00:21", "valueByLocale": null } ], "fieldData": [ { "id": "304411211", "name": "Origin", "value": "Agent", "valueByLocale": null }, { "id": "1", "name": "Display ID", "value": "CASE-0000000214", "valueByLocale": null }, { "id": "8", "name": "Summary", "value": "tedt", "valueByLocale": null } ], "resolvedFieldData": { "id": "AGGADGG8ECDC2AS6FQTUS6FQTUP9CX", "displayId": "CASE-0000000214", "summary": "tedt", "createdBy": "tadmin", "createdDate": "2024-07-05T15:53:54.000Z", "modifiedBy": "tadmin", "modifiedDate": "2024-07-22T12:12:49.000Z", "assignee": "apetersen", "assigneeFullName": "Alviro Petersen", "template": "Automated Test 1", "description": null, "priority": 3000, "priorityLabel": "Medium", "requester": "hhaas", "requesterFullName": "Hannah Haas", "contact": null, "company": "Petramco", "categoryTier1": null, "categoryTier2": null, "categoryTier3": null, "categoryTier4": null, "assignedCompany": "Petramco", "businessUnit": "Australia Support", "supportOrganization": "Australia Support", "supportGroup": "AU Support 1", "site": "Aichi", "region": "Asia-Pac", "origin": "Agent", "statusReason": null, "flowset": null, "assigneeGuid": "AGGAA5V0HI5R3ANAVP9TU6W2DDE82N", "serviceRequestGuid": null, "serviceRequestId": null, "dynamicData": {}, "questions": [], "label": null, "targetDate": null, "lineOfBusiness": "Human Resource", "siteGroup": "Engineering", "externalSystemRequestId": null, "externalSystemDetails": null, "resolutionDescription": null, "resolutionCode": null, "status": "In Progress" } } |
| 404 | Not found |
| 400 | Bad request |
| 500 | Internal Server Error |
List cases – API V1
To retrieve case details information
Additional headers
| Name | Description |
| Content-Type | application/json |
Endpoint
Path parameters
None
Query parameters
| Name | Type | Description |
| queryExpression | String | A case GUID, couldn't be missed or blank. |
| pageSize | Number | A maximum number of records to be returned. |
| startIndex | Number | An index of first record. |
| sortByFieldId | String | A field id for sorting of returned records. For example:
|
Response
| Status code | Description |
| 200 OK | { "totalSize": 1, "data": [ { "id": "AGGADGG8ECDC1ATBB3EYTBB3EY71DA", "displayId": "CASE-0000000005", "summary": "test", "createdBy": "tadmin", "createdDate": "2025-08-15T12:53:22.000Z", "modifiedBy": "tadmin", "modifiedDate": "2025-08-15T12:53:22.000Z", "assignee": null, "assigneeFullName": null, "template": null, "description": null, "priority": 3000, "priorityLabel": "Medium", "requester": "hhaas", "requesterFullName": "Hannah Haas", "contact": null, "company": "Petramco", "categoryTier1": null, "categoryTier2": null, "categoryTier3": null, "categoryTier4": null, "assignedCompany": "Petramco", "businessUnit": "HR Support", "supportOrganization": "HR Support", "supportGroup": "Workforce Administration", "site": "Aichi", "region": "Asia-Pac", "origin": "Agent", "statusReason": null, "flowset": null, "assigneeGuid": null, "serviceRequestGuid": null, "serviceRequestId": null, "dynamicData": {}, "questions": [], "label": null, "targetDate": null, "lineOfBusiness": "Human Resource", "siteGroup": "Engineering", "externalSystemRequestId": null, "externalSystemDetails": null, "resolutionDescription": null, "resolutionCode": null, "status": "New" } ] } |
| 404 | Not found |
| 400 | Bad request |
| 500 | Internal Server Error |
List cases – API V3
Retrieve multiple cases with support for pagination, filtering, and optional field selection.
Additional headers
| Name | Description |
| Content-Type | application/json |
Endpoint
Path parameters
None
Query parameters
None
Request Body parameters (JSON)
| Property Name | Type | Description |
|---|---|---|
| startIndex | integer | Starting index for the results (used for pagination). |
| pageSize | integer | Number of results to return per page. |
| sortByFieldId | String | A field id for sorting of returned records. For example:
|
| queryExpression | String | Qualification expression for filtering results, e.g., 'Requester'="hhaas". |
| lineOfBusiness | String | Optional. Specifies the line of business, e.g., "HumanResource". |
| requestedData | Object | Optional. Contains any combination of the properties listed above to control the data returned in the case. See Requested Data Object. |
Requested Data Object (used inside requestedData)
| Property Name | Type | Description |
|---|---|---|
| includeFieldData | Boolean | If true, includes values from Case RD (Record Definition) fields. |
| includeExtensionFieldData | Boolean | If true, includes values from Case Extension RD fields. |
| includeDynamicData | Boolean | If true, includes dynamic fields such as runtime-calculated or workflow-populated values. |
| includeResolvedFieldData | Boolean | If true, includes resolved values for system fields such as Requester and Contact (translates GUIDs/login names to full names). |
| casePropertySelection | String | Comma-separated string. Specifies which Case RD field IDs (e.g., 1,379,450000010) should be included in the response. |
| caseExtensionPropertySelection | String | Comma-separated string. Specifies which Case Extension RD field IDs should be included in the response. |
Request body example
"startIndex": 0,
"pageSize": 50,
"lineOfBusiness": "HumanResource",
"queryExpression": "'379'= \"AGGADGG8ECDC2AS6FQTUS6FQTUP9CX\"",
"requestedData": {
"includeResolvedFieldData": true,
"includeDynamicData": true,
"includeFieldData": true,
"includeExtensionFieldData": true,
"casePropertySelection": "1,304411211,8",
"caseExtensionPropertySelection": "1,536870913,536870914,536870915,536870916,536870917"
}
}
Response
| Status code | Description |
| 200 OK | { "totalSize": 1, "data": [ { "displayId": "CASE-0000000214", "id": "AGGADGG8ECDC2AS6FQTUS6FQTUP9CX", "dynamicData": [ { "questionType": 1000, "questionTypeLabel": "TEXT", "answer": "100", "questionId": "4bb23fad-f856-ae86-db55-b054187dda0d", "dataProviderUserRole": "Requester", "taskOnly": false, "questionScope": "Global", "label": "What is the amount?", "question": "What is the amount?" } ], "extensionFieldData": [ { "id": "536870915", "name": "E_DateTime", "value": "2024-07-11T00:25:00.000Z", "valueByLocale": null }, { "id": "1", "name": "Display ID", "value": "000000000000001", "valueByLocale": null }, { "id": "536870916", "name": "E_Date", "value": "2024-07-04", "valueByLocale": null }, { "id": "536870917", "name": "E_Boolean", "value": 0, "valueByLocale": null }, { "id": "536870913", "name": "E_Text", "value": "Extension Field Value", "valueByLocale": null }, { "id": "536870914", "name": "E_Time", "value": "12:00:21", "valueByLocale": null } ], "fieldData": [ { "id": "304411211", "name": "Origin", "value": "Agent", "valueByLocale": null }, { "id": "1", "name": "Display ID", "value": "CASE-0000000214", "valueByLocale": null }, { "id": "8", "name": "Summary", "value": "tedt", "valueByLocale": null } ], "resolvedFieldData": { "id": "AGGADGG8ECDC2AS6FQTUS6FQTUP9CX", "displayId": "CASE-0000000214", "summary": "tedt", "createdBy": "tadmin", "createdDate": "2024-07-05T15:53:54.000Z", "modifiedBy": "tadmin", "modifiedDate": "2024-07-22T12:12:49.000Z", "assignee": "apetersen", "assigneeFullName": "Alviro Petersen", "template": "Automated Test 1", "description": null, "priority": 3000, "priorityLabel": "Medium", "requester": "hhaas", "requesterFullName": "Hannah Haas", "contact": null, "company": "Petramco", "categoryTier1": null, "categoryTier2": null, "categoryTier3": null, "categoryTier4": null, "assignedCompany": "Petramco", "businessUnit": "Australia Support", "supportOrganization": "Australia Support", "supportGroup": "AU Support 1", "site": "Aichi", "region": "Asia-Pac", "origin": "Agent", "statusReason": null, "flowset": null, "assigneeGuid": "AGGAA5V0HI5R3ANAVP9TU6W2DDE82N", "serviceRequestGuid": null, "serviceRequestId": null, "dynamicData": {}, "questions": [], "label": null, "targetDate": null, "lineOfBusiness": "Human Resource", "siteGroup": "Engineering", "externalSystemRequestId": null, "externalSystemDetails": null, "resolutionDescription": null, "resolutionCode": null, "status": "In Progress" } } |
| 404 | Not found |
| 400 | Bad request |
| 500 | Internal Server Error |
Create a case – API V1
This endpoint allows creating a Case without attachments by accepting an application/json request body.
When successful, the response includes the URI of the created resource in the Location header.
Additional headers
| Name | Description |
| Content-Type | application/json |
Endpoint
Path parameters
None
Query parameters
None
Request Body parameters (JSON)
| Property Name | Type | Description |
|---|---|---|
Requester* | String | Requester person identifier. Either login id or GUID. |
Summary* | String | Case summary. Only required if not specified case template ID. |
Description | String | Case description. |
ActivityNoteText | String | Activity Notes message to be added, RTF Text. |
| ActivityNotePublicVisibility | Boolean | Property: true → A public note is created false → A private note is created Not defined → Defaults to a private note. |
Contact | String | Contact person identifier. Either login id or GUID. |
Case Template ID | String | Case template Id. |
Company | String | A company name. |
Business Unit | String | Assigned Support Organization. |
Department | String | Assigned Department. Do Not Use - to be deprecated. |
Assignee | String | Assignee. |
Assigned Company | String | Assigned Company. |
Support Group | String | A support group name. |
External Email Id | String | Any string. |
EmailContextData | String | Object, Email Context Data document definition. |
ExternalSystem Details | String | Field can be used to store the details with any External Integration like URL, hostname etc. |
ExternalSystem Request ID | String | Field can be used to store the Request ID of any external system Integration. |
| Target Date | String | Date/Time value. |
Line of Business | String | Line of Business Domain Id. |
Other Fields | String | Json payload for custom fields on a case. See "Other Fields structure". |
Extension Fields | String | Json payload for custom fields on extension RD related to a case. See "Extension Fields structure". |
Category Tier 1 | String | Any string. |
Category Tier 2 | String | Any string. |
Category Tier 3 | String | Any string. |
Category Tier 4 | String | Any string. |
Site | String | Any string. |
Region | String | Any string. |
Priority | String | A priority index. Critical (1000), High(2000), Medium(3000), Low(4000). |
Target Date | String | Date/Time value. |
Status | String | Any string. |
Create Service Request | Boolean | Boolean value. Used from connector, passes false. No default value here. we want to ignore if not passed. |
Origin | String | The Origin of where the case is created from: DWP, Quick Case, Create Case, etc. |
Status Reason | String | A Status Reason. |
Label | String | Any string. |
| reconIds | String | Asset relationship input. |
| assetFields | String | Asset relationship input. |
Other Fields structure
The Other Fields object is used to set additional field values when creating or updating a case.
It contains an array of field objects, where each object identifies the field by its ID and provides the new value.
"Other Fields": {
"fields": [
{
"fieldId": "450000177",
"value": "New value for resolution description field"
}
]
}
}
Extension Fields structure
The Extension Fields object is used to provide values for case extension fields that belong to a specific Line of Business (LoB).
It specifies the record definition, the line of business, and the array of extension field objects.
"Extension Fields": {
"recordDefinition": "com.bmc.dsm.lob.human-resource:Case Extension Fields",
"lineOfBusiness": "HumanResource",
"fields": [
{
"fieldId": "536870913",
"value": "New value for Extension field"
}
]
}
}
Request body example
"Requester": "hhaas",
"Summary": "Manager has asked for a spot bonus for an employee.",
"Description": "<strong>RTF Content</strong>\n<p>Verify if the employee is eligible for a spot bonus and if so, please register in the HCM system.</p>",
"ActivityNoteText": "<b>1st activity note</b>",
"Contact": "Elizabeth",
"Case Template ID": "AGGCEME2HPULZAOQMOBCOPQLT9RTCB",
"Company": "Petramco",
"Business Unit": "Australia Support",
"Assignee": "IDGAA5V0HI5R3ANATZZCTF3VS8CEEC",
"Assigned Company": "Petramco",
"Support Group": "AU Support 1",
"Category Tier 1": "Applications",
"Category Tier 2": "Social",
"Category Tier 3": "Chatter",
"Site": "Aichi",
"Priority": "2000",
"Create Service Request": true,
"Origin": "Agent",
"Other Fields": {
"fields": [
{
"fieldId": "450000177",
"value": "Initial value for resolution description"
}
]
}
}
Response
| Status code | Description |
| 201 Created | Headers: Location: {{server}}/api/com.bmc.dsm.case-lib/cases/AGGADGG8ECDC1ATBB65KTBB65K7KC2 URL of the newly created case resource. The trailing segment is the Case ID. |
| 404 | Not found |
| 400 | Bad request |
| 500 | Internal Server Error |
Create a case – API V2
This endpoint allows creating a Case with attachments by accepting a multipart/form-data request body.
When successful, the response includes the URI of the created resource in the Location header.
Additional headers
| Name | Description |
| Content-Type | multipart/form-data |
Endpoint
Path parameters
None
Query parameters
None
Body (form-data)
| Form-Data Key | Type | Description |
|---|---|---|
caseData | Text | JSON string with case fields. The structure is identical to the request body of the Case Create V1 API. |
attachment | File | First attachment file. Optional. |
| attachment2 | File | Second attachment file. Optional. |
| attachmentN | File | Any additional attachments (N is not limited). Optional. |
Request body example
| Form-Data Key | Type | Example value |
|---|---|---|
caseData | Text | { "Summary": "Manager has asked for a spot bonus for an employee",.. } JSON string with case fields. The structure is identical to the request body of the Case Create V1 API. |
attachment1 | File | photo_1.jpg First attachment file. |
| attachment2 | File | photo_2.jpg Second attachment file. |
| attachment3 | File | document.pdf Third attachment file. |
Response
| Status code | Description |
| 201 Created | Headers: Location: {{server}}/api/com.bmc.dsm.case-lib/cases/AGGADGG8ECDC1ATBB65KTBB65K7KC2 URL of the newly created case resource. The trailing segment is the Case ID. |
| 404 | Not found |
| 400 | Bad request |
| 500 | Internal Server Error |
Create a case – API V3
This endpoint allows creating a Case with attachments by accepting a multipart/form-data request body.
On success, the response contains the case details along with dynamic data.
Additional headers
| Name | Description |
| Content-Type | multipart/form-data |
Endpoint
Path parameters
None
Query parameters
None
Body (form-data)
| Form-Data Key | Type | Description |
|---|---|---|
caseData | Text | JSON string with case fields. The structure is identical to the request body of the Case Create V1 API. |
attachment | File | First attachment file. Optional. |
| attachment2 | File | Second attachment file. Optional. |
| attachmentN | File | Any additional attachments (N is not limited). Optional. |
Request body example
| Form-Data Key | Type | Example value |
|---|---|---|
caseData | Text | { "Summary": "Manager has asked for a spot bonus for an employee",.. } JSON string with case fields. The structure is identical to the request body of the Case Create V1 API. |
attachment1 | File | photo_1.jpg First attachment file. |
| attachment2 | File | photo_2.jpg Second attachment file. |
| attachment3 | File | document.pdf Third attachment file. |
Response
| Status code | Description |
| 200 OK | { "displayId": "CASE-0000000107", "id": "AGGADGG8ECDC0ATBLVX7TBLVX70OM7", "dynamicData": [ { "questionType": 1000, "questionTypeLabel": "TEXT", "answer": null, "questionId": "507df97e-b82e-f037-b4fb-fe1627f2f787", "dataProviderUserRole": "Requester", "taskOnly": false, "questionScope": "Global", "label": "Full Name of Employee Nominated", "question": "Full Name of Employee Nominated" }, { "questionType": 1000, "questionTypeLabel": "TEXT", "answer": null, "questionId": "4bb23fad-f856-ae86-db55-b054187dda0d", "dataProviderUserRole": "Requester", "taskOnly": false, "questionScope": "Global", "label": "What is the amount?", "question": "What is the Amount?" } ], "extensionFieldData": [], "fieldData": [], "resolvedFieldData": { "id": "AGGADGG8ECDC0ATBLVX7TBLVX70OM7", "displayId": "CASE-0000000107", "summary": "Manager has asked for a spot bonus for an employee.", "createdBy": "tadmin", "createdDate": "2025-08-26T14:51:17.000Z", "modifiedBy": "tadmin", "modifiedDate": "2025-08-26T14:51:17.000Z", "assignee": "ajoshi", "assigneeFullName": "Anju Joshi", "template": "Spot Bonus Request", "description": "<strong>RTF Content</strong><br><p>Verify if the employee is eligible for a spot bonus and if so, please register in the HCM system.</p><br><p>Verify if the employee is eligible for a spot bonus and if so, please register in the HCM system.</p>", "priority": 2000, "priorityLabel": "High", "requester": "hhaas", "requesterFullName": "Hannah Haas", "contact": "Elizabeth", "company": "Petramco", "categoryTier1": "Applications", "categoryTier2": "Social", "categoryTier3": "Chatter", "categoryTier4": null, "assignedCompany": "Petramco", "businessUnit": "Australia Support", "supportOrganization": "Australia Support", "supportGroup": "AU Support 1", "site": "Aichi", "region": "Asia-Pac", "origin": "Agent", "statusReason": null, "flowset": null, "assigneeGuid": "IDGAA5V0HI5R3ANATZZCTF3VS8CEEC", "serviceRequestGuid": null, "serviceRequestId": null, "dynamicData": {}, "questions": [], "label": null, "targetDate": null, "lineOfBusiness": "Human Resource", "siteGroup": "Engineering", "externalSystemRequestId": null, "externalSystemDetails": null, "resolutionDescription": null, "resolutionCode": null, "status": "Assigned" } } |
| 404 | Not found |
| 400 | Bad request |
| 500 | Internal Server Error |
Update a case – API V1
This endpoint allows updating a Case without attachments by accepting an application/json request body.
When successful, the response includes the URI of the created resource in the Location header.
Additional headers
| Name | Description |
| Content-Type | application/json |
Endpoint
Path parameters
| Name | Type | Description |
| id | String | A case GUID, couldn't be missed or blank. |
Query parameters
None
Request Body parameters (JSON)
| Property Name | Type | Description |
|---|---|---|
Summary | String | Case summary. |
Description | String | Case description. |
ActivityNoteText | String | Activity Notes message to be added, RTF Text. |
| ActivityNotePublicVisibility | Boolean | Property: true → A public note is created false → A private note is created Not defined → Defaults to a private note. |
Contact | String | Contact person identifier. Either login id or GUID. |
Business Unit | String | Assigned Support Organization. |
Department | String | Assigned Department. Do Not Use - to be deprecated. |
Assignee | String | Assignee login name or GUID. |
Assigned Company | String | Assigned Company. |
Support Group | String | A support group name. |
ExternalSystem Details | String | Field can be used to store the details with any External Integration like URL, hostname etc. |
ExternalSystem Request ID | String | Field can be used to store the Request ID of any external system Integration. |
Other Fields | String | Json payload for custom fields on a case. See "Other Fields structure". |
Extension Fields | String | Json payload for custom fields on extension RD related to a case. See "Extension Fields structure". |
Category Tier 1 | String | Any string. |
Category Tier 2 | String | Any string. |
Category Tier 3 | String | Any string.. |
Category Tier 4 | String | Any string. |
Priority | String | A priority index. Critical (1000), High(2000), Medium(3000), Low(4000). |
Target Date | String | Date/Time value. |
Status | String | Any string. |
Status Reason | String | A Status Reason. |
| Target Date | String | Date/Time value. |
Label | String | Any string. |
Request body example
"Category Tier 1": "Applications",
"Category Tier 2": "Help Desk",
"Category Tier 3": "Service Request",
"Label": "Benefits",
"ActivityNoteText": "Some message Text",
"Assigned Company": "Petramco",
"Business Unit": "HR Support",
"Support Group": "Employee Relations",
"Assignee": "Peter",
"Other Fields": {
"fields": [
{
"fieldId": "450000177",
"value": "New value for resolution description field"
}
]
}
}
Response
| Status code | Description |
| 200 OK | { "id": "AGGADGG8ECDC0ATBLUE2TBLUE206WA", "displayId": "CASE-0000000101", "summary": "Case Summary", "createdBy": "tadmin", "createdDate": "2025-08-26T14:12:12.000Z", "modifiedBy": "tadmin", "modifiedDate": "2025-09-02T11:35:35.000Z", "assignee": "Peter", "assigneeFullName": "Peter Kahn", "template": null, "description": "Case Description", "priority": 1000, "priorityLabel": "Critical", "requester": "ejeffries", "requesterFullName": "Elizabeth Jeffries", "contact": "hhaas", "company": "Petramco", "categoryTier1": "Applications", "categoryTier2": "Help Desk", "categoryTier3": "Service Request", "categoryTier4": null, "assignedCompany": "Petramco", "businessUnit": "HR Support", "supportOrganization": "HR Support", "supportGroup": "Employee Relations", "site": null, "region": null, "origin": "Agent", "statusReason": null, "flowset": null, "assigneeGuid": "AGGCEME2HPULZAOQMLOFOPQ96MRPDZ", "serviceRequestGuid": null, "serviceRequestId": null, "dynamicData": {}, "questions": [], "label": "Benefits", "targetDate": null, "lineOfBusiness": "Human Resource", "siteGroup": null, "externalSystemRequestId": "id details", "externalSystemDetails": "details", "resolutionDescription": "New value for resolution description field", "resolutionCode": null, "status": "Assigned" } |
| 404 | Not found |
| 400 | Bad request |
| 500 | Internal Server Error |
Update a case – API V2
This endpoint allows updating a Case with attachments by accepting a multipart/form-data request body.
On success, the response contains the case details along with dynamic data.
Additional headers
| Name | Description |
| Content-Type | multipart/form-data |
Endpoint
Path parameters
| Name | Type | Description |
| id | String | A case GUID, couldn't be missed or blank. |
Query parameters
None
Body (form-data)
| Form-Data Key | Type | Description |
|---|---|---|
caseData | Text | JSON string with case fields. The structure is identical to the request body of the Case Update V1 API. |
attachment | File | First attachment file. Optional. |
| attachment2 | File | Second attachment file. Optional. |
| attachmentN | File | Any additional attachments (N is not limited). Optional. |
Request body example
| Form-Data Key | Type | Example value |
|---|---|---|
caseData | Text | { "Summary": "Manager has asked for a spot bonus for an employee",.. } JSON string with case fields. The structure is identical to the request body of the Case Update V1 API. |
attachment1 | File | photo_1.jpg First attachment file. |
| attachment2 | File | photo_2.jpg Second attachment file. |
| attachment3 | File | document.pdf Third attachment file. |
Response
| Status code | Description |
| 200 OK | { "id": "AGGADGG8ECDC0ATBLUE2TBLUE206WA", "displayId": "CASE-0000000101", "summary": "Case Summary", "createdBy": "tadmin", "createdDate": "2025-08-26T14:12:12.000Z", "modifiedBy": "tadmin", "modifiedDate": "2025-08-26T17:30:20.000Z", "assignee": "Peter", "assigneeFullName": "Peter Kahn", "template": null, "description": "Case Description", "priority": 1000, "priorityLabel": "Critical", "requester": "ejeffries", "requesterFullName": "Elizabeth Jeffries", "contact": "hhaas", "company": "Petramco", "categoryTier1": "Applications", "categoryTier2": "Help Desk", "categoryTier3": "Service Request", "categoryTier4": null, "assignedCompany": "Petramco", "businessUnit": "HR Support", "supportOrganization": "HR Support", "supportGroup": "Employee Relations", "site": null, "region": null, "origin": "Agent", "statusReason": null, "flowset": null, "assigneeGuid": "AGGCEME2HPULZAOQMLOFOPQ96MRPDZ", "serviceRequestGuid": null, "serviceRequestId": null, "dynamicData": {}, "questions": [], "label": "Benefits", "targetDate": null, "lineOfBusiness": "Human Resource", "siteGroup": null, "externalSystemRequestId": "id details", "externalSystemDetails": "details", "resolutionDescription": null, "resolutionCode": null, "status": "Assigned" } |
| 404 | Not found |
| 400 | Bad request |
| 500 | Internal Server Error |
List case tasks – API V1
To retrieve case tasks information.
Additional headers
| Name | Description |
| Content-Type | application/json |
Endpoint
Path parameters
| Name | Type | Description |
| id | String | A case GUID, couldn't be missed or blank. |
Query parameters
None
Response
| Status code | Description |
| 200 OK | { "totalSize": 1, "data": [ { "id": "AGGADGG8ECDC0ATBME9QTBME9Q17P4", "displayId": "TASK-0000000113", "status": 1000, "summary": "Corrective Action", "createdBy": "tadmin", "createdDate": "2025-08-26T17:57:26.000Z", "modifiedBy": "tadmin", "modifiedDate": "2025-08-26T17:57:26.000Z", "assignee": "Elizabeth", "assigneeFullName": "Elizabeth Peters", "caseId": "AGGADGG8ECDC1ATAVZJZTAVZJZEOD6", "description": "<p>ASSURE..........Confidentiality will be maintained to the fullest extent possible, consistent with the need to conduct an adequate review and subject to requirements of law. DOCUMENT .....Prompt and appropriate corrective action will be taken when and as warranted in the judgment of the Audit Committee RE-c38d420dd22434103caf44e8cd186547df089d75b2f3fc3145a7b9acbad40f68e12a4a1e192fef8de9a188db1be1f561e1514a238d010dceb68afd360be7d448ERATE ....The Company will not discharge, demote, suspend, threaten, harass or in any manner discriminate against any employee in the terms and conditions of employment based upon any lawful actions of such employee with respect to good faith reporting of complaints or concerns regarding Accounting Matters or otherwise as specified in Section 806 of the Sarbanes-Oxley Act of 2002.</p>", "priority": 2000, "priorityLabel": "High", "ticketStatus": "Staged", "ticketStatusGuid": "AGGAA5V0GE9Z4AOPT27GOOX129JWDO", "contact": "hhaas", "requester": "hhaas", "company": "Petramco", "categoryTier1": "Employee Relations", "categoryTier2": null, "categoryTier3": null, "categoryTier4": null, "sequence": 1, "taskType": 0, "taskTypeLabel": "Manual", "processName": null, "assigneeGuid": "AGGCEME2HPULZAOQTK5LOPX8IDZTV1", "assignedCompany": "Petramco", "supportOrganization": "HR Support", "businessUnit": "HR Support", "assignedGroup": "Employee Relations", "statusReason": null, "statusReasonCode": 0, "templateId": "AGGCEME2HPULZAORVJ97OQZFQU1J65", "dynamicDataDefinitionId": null, "dynamicData": {}, "label": null, "targetDate": null, "serviceRequestGUID": null, "serviceRequestDisplayID": null, "dataUpgradeAction": null, "lobId": "HumanResource", "lineOfBusiness": "Human Resource", "externalSystemRequestId": null, "externalSystemDetails": null, "completedDate": null, "templateName": "Accounting and Auditing -- Corrective Action", "title": null, "serviceId": "", "todoServiceRequestId": null, "questionnaireId": "", "stage": null } ] } |
| 404 | Not found |
| 400 | Bad request |
| 500 | Internal Server Error |
Retrieve a case task – API V1
To retrieve case tasks information.
Additional headers
| Name | Description |
| Content-Type | application/json |
Endpoint
Path parameters
| Name | Type | Description |
| id | String | A case GUID, couldn't be missed or blank. |
| taskid | String | A task GUID, couldn't be missed or blank. |
Query parameters
None
Response
| Status code | Description |
| 200 OK | { "id": "AGGADGG8ECDC0ATBME9QTBME9Q17P4", "displayId": "TASK-0000000113", "status": 2000, "summary": "Corrective Action", "createdBy": "tadmin", "createdDate": "2025-08-26T17:57:26.000Z", "modifiedBy": "tadmin", "modifiedDate": "2025-08-26T18:03:18.000Z", "assignee": "Elizabeth", "assigneeFullName": "Elizabeth Peters", "caseId": "AGGADGG8ECDC1ATAVZJZTAVZJZEOD6", "description": "<p>ASSURE..........Confidentiality will be maintained to the fullest extent possible, consistent with the need to conduct an adequate review and subject to requirements of law. DOCUMENT .....Prompt and appropriate corrective action will be taken when and as warranted in the judgment of the Audit Committee RE-c38d420dd22434103caf44e8cd186547df089d75b2f3fc3145a7b9acbad40f68e12a4a1e192fef8de9a188db1be1f561e1514a238d010dceb68afd360be7d448ERATE ....The Company will not discharge, demote, suspend, threaten, harass or in any manner discriminate against any employee in the terms and conditions of employment based upon any lawful actions of such employee with respect to good faith reporting of complaints or concerns regarding Accounting Matters or otherwise as specified in Section 806 of the Sarbanes-Oxley Act of 2002.</p>", "priority": 2000, "priorityLabel": "High", "ticketStatus": "Assigned", "ticketStatusGuid": "AGGAA5V0GE9Z4AOPT29EOOX147JWEE", "contact": "hhaas", "requester": "hhaas", "company": "Petramco", "categoryTier1": "Employee Relations", "categoryTier2": null, "categoryTier3": null, "categoryTier4": null, "sequence": 1, "taskType": 0, "taskTypeLabel": "Manual", "processName": null, "assigneeGuid": "AGGCEME2HPULZAOQTK5LOPX8IDZTV1", "assignedCompany": "Petramco", "supportOrganization": "HR Support", "businessUnit": "HR Support", "assignedGroup": "Employee Relations", "statusReason": null, "statusReasonCode": 0, "templateId": "AGGCEME2HPULZAORVJ97OQZFQU1J65", "dynamicDataDefinitionId": null, "dynamicData": {}, "label": null, "targetDate": null, "serviceRequestGUID": null, "serviceRequestDisplayID": null, "dataUpgradeAction": null, "lobId": "HumanResource", "lineOfBusiness": "Human Resource", "externalSystemRequestId": null, "externalSystemDetails": null, "completedDate": null, "templateName": "Accounting and Auditing -- Corrective Action", "title": null, "serviceId": "", "todoServiceRequestId": null, "questionnaireId": "", "stage": null } |
| 404 | Not found |
| 400 | Bad request |
| 500 | Internal Server Error |
Create a task – API V1
This endpoint allows creating a Task without attachments by accepting an application/json request body.
When successful, the response includes the URI of the created resource in the Location header.
The Task API supports only External tasks. Any task created through this API will always be of the External type.
Additional headers
| Name | Description |
| Content-Type | application/json |
Endpoint
Path parameters
| Name | Type | Description |
| id | String | A case GUID, couldn't be missed or blank. |
Query parameters
None
Request Body parameters (JSON)
| Property Name | Type | Description |
|---|---|---|
Summary* | String | Task summary. Only required if not specified task template ID. |
Description | String | Task description. |
| Task Template ID | String | Task template Id. |
Business Unit | String | Assigned Support Organization. |
Department | String | Assigned Department. |
Assignee | String | Assignee. |
Assigned Company | String | Assigned Company. |
| Assigned Group | String | A support group name. |
| ExternalSystem Details | String | Field can be used to store the details with any External Integration like URL, hostname etc. |
| ExternalSystem Request ID | String | Field can be used to store the Request ID of any external system Integration. |
Extra Data | String | Any string. |
Category Tier 1 | String | Any string. |
Category Tier 2 | String | Any string. |
Category Tier 3 | String | Any string. |
Category Tier 4 | String | Any string. |
Label | String | Any string. |
| Priority | String | A priority index. Critical (1000), High(2000), Medium(3000), Low(4000). |
Request body example
"Description": "Corrective Action",
"Category Tier 1": "Employee Relations",
"Category Tier 2": "Compensation",
"Category Tier 3": "Bonus",
"Assignee": "Elizabeth",
"Summary": "Task Summary value",
"Assigned Group": "Employee Relations",
"Assigned Company": "Petramco",
"Business Unit": "HR Support",
"ExternalSystem Request ID": "request id",
"ExternalSystem Details": "request details"
}
Response
| Status code | Descriptionupdat |
| 201 Created | Headers: Location: {{server}}/api/com.bmc.dsm.case-lib/cases/AGGADGG8ECDC1ATAVZJZTAVZJZEOD6/tasks/v2/AGGADGG8ECDC0ATBN1T5TBN1T53WUT URL of the newly created case resource. Case Id = AGGADGG8ECDC1ATAVZJZTAVZJZEOD6 Task Id = AGGADGG8ECDC0ATBN1T5TBN1T53WUT |
| 404 | Not found |
| 400 | Bad request |
| 500 | Internal Server Error |
Create a task– API V2
This endpoint creates a task with attachments by accepting a multipart/form-data request body.
When successful, the response includes the URI of the created resource in the Location header.
The Task API supports only External tasks. Any task created through this API will always be of the External type.
Additional headers
| Name | Description |
| Content-Type | multipart/form-data |
Endpoint
Path parameters
| Name | Type | Description |
| id | String | A case GUID, couldn't be missed or blank. |
Query parameters
None
Body (form-data)
| Form-Data Key | Type | Description |
|---|---|---|
taskData | Text | JSON string with task fields. The structure is identical to the request body of the Create a task– API V1. |
attachment | File | First attachment file. Optional. |
| attachment2 | File | Second attachment file. Optional. |
| attachmentN | File | Any additional attachments (N is not limited). Optional. |
Request body example
| Form-Data Key | Type | Example value |
|---|---|---|
taskData | Text | { "Summary": "Manager has asked for a spot bonus for an employee",.. } JSON string with task fields. The structure is identical to the request body of the Create a task– API V1. |
attachment1 | File | First attachment file. photo_1.jpg |
| attachment2 | File | Second attachment file. photo_2.jpg |
| attachment3 | File | Third attachment file. document.pdf |
Response
| Status code | Description |
| 201 Created | Headers: Location: {{server}}/api/com.bmc.dsm.case-lib/cases/AGGADGG8ECDC1ATAVZJZTAVZJZEOD6/tasks/v2/AGGADGG8ECDC0ATBN1T5TBN1T53WUT URL of the newly created case resource. Case Id = AGGADGG8ECDC1ATAVZJZTAVZJZEOD6 Task Id = AGGADGG8ECDC0ATBN1T5TBN1T53WUT |
| 404 | Not found |
| 400 | Bad request |
| 500 | Internal Server Error |
Update a task – API V1
This endpoint allows updating a Task without attachments by accepting an application/json request body.
When successful, the response includes the URI of the created resource in the Location header.
This API allows updates to tasks of type External only.
Additional headers
| Name | Description |
| Content-Type | application/json |
Endpoint
Path parameters
| Name | Type | Description |
| id | String | A task GUID, couldn't be missed or blank. |
Query parameters
None
Request Body parameters (JSON)
| Property Name | Type | Description |
|---|---|---|
Summary | String | Task summary. |
Description | String | Task description. |
Business Unit | String | Assigned Support Organization. |
Department | String | Assigned Department. |
Assignee | String | Assignee. |
Assigned Company | String | Assigned Company. |
| Assigned Group | String | A support group name. |
| ExternalSystem Details | String | Field can be used to store the details with any External Integration like URL, hostname etc. |
| ExternalSystem Request ID | String | Field can be used to store the Request ID of any external system Integration. |
Category Tier 1 | String | Any string. |
Category Tier 2 | String | Any string. |
Category Tier 3 | String | Any string. |
Category Tier 4 | String | Any string. |
Label | String | Any string. |
| Priority | String | A priority index. Critical (1000), High(2000), Medium(3000), Low(4000). |
| Status | String | Any string. |
| Status Reason | String | Any string. |
ActivityNoteText | String | Activity Notes message to be added, RTF Text. |
| ActivityNotePublicVisibility | Boolean | Property: true → A public note is created false → A private note is created Not defined → Defaults to a private note. |
Request body example
"Category Tier 1" : "Applications",
"Category Tier 2" : "Help Desk",
"Category Tier 3" : "Service Request",
"Label" : "Benefits",
"Contact" : "hhaas",
"ActivityNoteText": "Some message Text",
"Assigned Company": "Petramco",
"Business Unit": "HR Support",
"Support Group": "Employee Relations",
"Assignee" : "Peter",
"ExternalSystem Details" : "details",
"ExternalSystem Request ID": "id details",
"Priority" : "3000"
}
Response
| Status code | Description |
| 200 OK | { "id": "AGGADGG8ECDC0ATBN1T5TBN1T53WUT", "displayId": "TASK-0000000121", "status": 1000, "summary": "Task summary", "createdBy": "tadmin", "createdDate": "2025-08-27T09:32:03.000Z", "modifiedBy": "tadmin", "modifiedDate": "2025-08-27T09:46:45.000Z", "assignee": null, "assigneeFullName": "Peter Kahn", "caseId": "AGGADGG8ECDC1ATAVZJZTAVZJZEOD6", "description": "Corrective Action", "priority": 3000, "priorityLabel": "Medium", "ticketStatus": "Staged", "ticketStatusGuid": "AGGAA5V0GE9Z4AOPT27GOOX129JWDO", "contact": "hhaas", "requester": "hhaas", "company": "Petramco", "categoryTier1": "Applications", "categoryTier2": "Help Desk", "categoryTier3": "Service Request", "categoryTier4": null, "sequence": 9, "taskType": 10, "taskTypeLabel": "External", "processName": null, "assigneeGuid": "Peter", "assignedCompany": "Petramco", "supportOrganization": "HR Support", "businessUnit": "HR Support", "assignedGroup": "Employee Relations", "statusReason": null, "statusReasonCode": 0, "templateId": null, "dynamicDataDefinitionId": null, "dynamicData": {}, "label": "AGGADGG8ECDC0AQ7872FQ6KFN0L9QA", "targetDate": null, "serviceRequestGUID": null, "serviceRequestDisplayID": null, "dataUpgradeAction": null, "lobId": "HumanResource", "lineOfBusiness": "Human Resource", "externalSystemRequestId": "id details", "externalSystemDetails": "details", "completedDate": null, "templateName": null, "title": null, "serviceId": null, "todoServiceRequestId": null, "questionnaireId": null, "stage": null } |
| 404 | Not found |
| 400 | Bad request |
| 500 | Internal Server Error |
Update a task – API V2
This endpoint allows updating a Task with attachments by accepting a multipart/form-data request body.
On success, the response contains the task details.
This API allows updates to tasks of type External only.
Additional headers
| Name | Description |
| Content-Type | multipart/form-data |
Endpoint
Path parameters
| Name | Type | Description |
| id | String | A task GUID, couldn't be missed or blank. |
Query parameters
None
Body (form-data)
| Form-Data Key | Type | Description |
|---|---|---|
taskData | Text | JSON string with task fields. The structure is identical to the request body of the Update a task – API V1. |
attachment | File | First attachment file. Optional. |
| attachment2 | File | Second attachment file. Optional. |
| attachmentN | File | Any additional attachments (N is not limited). Optional. |
Request body example
| Form-Data Key | Type | Example value |
|---|---|---|
| taskData | Text | { "Summary": "Manager has asked for a spot bonus for an employee",.. } The structure is identical to the request body of the Update a task – API V1. |
attachment1 | File | photo_1.jpg First attachment file. |
| attachment2 | File | photo_2.jpg Second attachment file. |
| attachment3 | File | document.pdf Third attachment file. |
Response
| Status code | Description |
| 200 OK | { "id": "AGGADGG8ECDC0ATBN1T5TBN1T53WUT", "displayId": "TASK-0000000121", "status": 1000, "summary": "Task summary", "createdBy": "tadmin", "createdDate": "2025-08-27T09:32:03.000Z", "modifiedBy": "tadmin", "modifiedDate": "2025-08-27T09:55:39.000Z", "assignee": null, "assigneeFullName": "Peter Kahn", "caseId": "AGGADGG8ECDC1ATAVZJZTAVZJZEOD6", "description": "Corrective Action", "priority": 3000, "priorityLabel": "Medium", "ticketStatus": "Staged", "ticketStatusGuid": "AGGAA5V0GE9Z4AOPT27GOOX129JWDO", "contact": "hhaas", "requester": "hhaas", "company": "Petramco", "categoryTier1": "Applications", "categoryTier2": "Help Desk", "categoryTier3": "Service Request", "categoryTier4": null, "sequence": 9, "taskType": 10, "taskTypeLabel": "External", "processName": null, "assigneeGuid": "Peter", "assignedCompany": "Petramco", "supportOrganization": "HR Support", "businessUnit": "HR Support", "assignedGroup": "Employee Relations", "statusReason": null, "statusReasonCode": 0, "templateId": null, "dynamicDataDefinitionId": null, "dynamicData": {}, "label": "AGGADGG8ECDC0AQ7872FQ6KFN0L9QA", "targetDate": null, "serviceRequestGUID": null, "serviceRequestDisplayID": null, "dataUpgradeAction": null, "lobId": "HumanResource", "lineOfBusiness": "Human Resource", "externalSystemRequestId": "id details", "externalSystemDetails": "details", "completedDate": null, "templateName": null, "title": null, "serviceId": null, "todoServiceRequestId": null, "questionnaireId": null, "stage": null } |
| 404 | Not found |
| 400 | Bad request |
| 500 | Internal Server Error |