Postman Collection for Core Case Management (CCMA) including examples

Srirama Akella

The Postman Collection for Core Case Management (CCMA) provides examples for the CCMA REST API calls. 

Click here to get the collection

Using the Postman Collection

Authentication

Use the Get Auth Token request to get an access token. This will automatically be saved as the environment variable tenant access_token, which will automatically be used for authorization in the other requests of the collection.

Environment Variables

The following requests automatically set environment variables for use in other requests:

1. Create Case Definition sets case_definition_id
2. Create Stage sets stage_id
3. Create Case sets case_id
4. Comment On Case sets comment_id

Form Data

The following requests use files in the body of their request. These files should be placed in C:\Users\{user}\Postman\files.

1. Update General Settings:

CaseInstanceDTO.json (example)

{
  "id": "d388103d-0e35-476b-9d92-6b99ec2a7f1c",
  "name": "Example Case",
  "description": "This is an example case",
  "classification": {
    "createdOn": "2021-01-12T16:09:09.193+0000",
    "lastUpdatedOn": "2021-01-12T16:09:09.193+0000",
    "id": "c30ae6fb-928e-48c3-a558-081b58f619e5",
    "name": "Enterprise"
  },
  "settings": {
    "duration": null,
    "defaultAssignee": null,
    "defaultAssigneeGroup": null,
    "email": null,
    "caseSLAs": []
  },
  "caseIdGenerator": {
    "createdOn": "2021-01-12T16:11:54.718+0000",
    "createdBy": "c30ae6fb-928e-48c3-a558-081b58f619e5",
    "lastUpdatedOn": "2021-01-12T16:11:54.718+0000",
    "lastUpdatedBy": "c30ae6fb-928e-48c3-a558-081b58f619e5",
    "id": "c30ae6fb-928e-48c3-a558-081b58f619e5",
    "prefix": "pre",
    "suffix": "suf",
    "sequenceName": "Numeric generator",
    "customGeneratorLogicEndpoint": null
  }
}

2. Create Case, Create Case with Attachments:

caseinstance1.json (example)

{
  "caseType": {
    "id": "d388103d-0e35-476b-9d92-6b99ec2a7f1c"
  },
  "caseConfigId": "b3177d3f-cf65-4f61-91aa-e85a1546ec30",
  "caseProperties": {
    "defaultAttributes": {
      "caseTitle": "Case Instance Example",
      "summary": "This is an example case instance",
      "clientName": "Bob"
    }
  }
}

Note: caseConfigId is returned in the response from the request Publish Case Definition