Paths
Query to get a list of cases
POST /hubs/{hubId}/cases/query
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
hubId |
A hub with an Action Management program configured |
integer (int32) |
Body |
body |
A query object for filtering, sorting, and paginating the list of cases |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Request is valid, list of cases returned |
|
400 |
Request is invalid, details in the response |
No Content |
404 |
Hub not found, or no Action Management program was found for the hub |
|
408 |
Request timed out |
No Content |
Example HTTP response
Response 200
{
"itemType" : "CaseListItem",
"itemCount" : 2,
"totalCount" : 2500,
"items" : [ {
"id" : 345678,
"name" : "Example case 345678",
"workflowId" : 543,
"workflowName" : "Example workflow 543",
"cost" : 500,
"isClosed" : false,
"triggerId" : 654,
"triggerName" : "Example trigger 654",
"dateCreated" : "2021-09-30T13:00:00+00:00",
"listValues" : [ {
"listId" : 23,
"id" : 987,
"name" : "In Progress",
"type" : "status",
"isOpen" : true
}, {
"listId" : 24,
"id" : 876,
"name" : "Critical",
"type" : "severity",
"isHigh" : true
}, {
"listId" : 25,
"id" : 765,
"name" : "Example category 765",
"type" : "category",
"subCategoryId" : 9087,
"subCategoryName" : "Example subcategory 9087"
}, {
"listId" : 27,
"id" : 764,
"name" : "Example custom list item 764",
"type" : "custom"
} ],
"roles" : [ {
"id" : 3456,
"caseId" : 345678,
"name" : "Case Manager",
"workflowRoleIsActive" : false,
"users" : [ {
"id" : 8790,
"userName" : "exampleUser8790",
"isActive" : true,
"links" : {
"self" : "http://example.org/v1/hubs/96/enduserlists/906/users/8790"
}
}, {
"id" : 8788,
"userName" : "exampleUser8788",
"isActive" : false,
"links" : {
"self" : "http://example.org/v1/hubs/96/enduserlists/906/users/8788"
}
} ]
}, {
"id" : 3457,
"caseId" : 345678,
"name" : "Watcher",
"workflowRoleIsActive" : false,
"users" : [ {
"id" : 8788,
"userName" : "exampleUser8788",
"isActive" : false,
"links" : {
"self" : "http://example.org/v1/hubs/96/enduserlists/906/users/8788"
}
}, {
"id" : 9870,
"userName" : "exampleUser9870",
"isActive" : true,
"links" : {
"self" : "http://example.org/v1/hubs/96/enduserlists/906/users/9870"
}
} ]
} ],
"dataFields" : [ {
"id" : 5423,
"caseId" : 345678,
"name" : "Customer Email",
"value" : "example.email@example.org",
"questionName" : "email"
}, {
"id" : 5424,
"caseId" : 345678,
"name" : "Overall satisfaction",
"value" : "Low",
"questionName" : "q1"
}, {
"id" : 5425,
"caseId" : 345678,
"name" : "Country",
"value" : "Canada",
"questionName" : "q5"
} ],
"links" : {
"self" : "http://example.org/v1/actionmanagement/hubs/96/cases/345678",
"notes" : "http://example.org/v1/actionmanagement/hubs/96/cases/345678/notes"
}
}, {
"id" : 345543,
"name" : "Example case 345543",
"workflowId" : 543,
"workflowName" : "Example workflow 543",
"cost" : 500,
"isClosed" : true,
"triggerId" : 654,
"triggerName" : "Example trigger 654",
"dateCreated" : "2021-09-01T15:00:00+00:00",
"listValues" : [ {
"listId" : 23,
"id" : 998,
"name" : "Completed",
"type" : "status",
"isOpen" : false
}, {
"listId" : 24,
"id" : 876,
"name" : "Critical",
"type" : "severity",
"isHigh" : true
}, {
"listId" : 25,
"id" : 778,
"name" : "Example category 778",
"type" : "category"
}, {
"listId" : 27,
"id" : 777,
"name" : "Example custom list item 777",
"type" : "custom"
} ],
"roles" : [ {
"id" : 3456,
"caseId" : 345543,
"name" : "Case Manager",
"workflowRoleIsActive" : false,
"users" : [ {
"id" : 9870,
"userName" : "exampleUser9870",
"isActive" : true,
"links" : {
"self" : "http://example.org/v1/hubs/96/enduserlists/906/users/9870"
}
} ]
}, {
"id" : 3457,
"caseId" : 345543,
"name" : "Watcher",
"workflowRoleIsActive" : false,
"users" : [ ]
} ],
"dataFields" : [ {
"id" : 5423,
"caseId" : 345543,
"name" : "Customer Email",
"value" : "",
"questionName" : "email"
}, {
"id" : 5424,
"caseId" : 345543,
"name" : "Overall satisfaction",
"value" : "Medium",
"questionName" : "q1"
}, {
"id" : 5425,
"caseId" : 345543,
"name" : "Country",
"value" : "France",
"questionName" : "q5"
} ],
"links" : {
"self" : "http://example.org/v1/actionmanagement/hubs/96/cases/345543",
"notes" : "http://example.org/v1/actionmanagement/hubs/96/cases/345543/notes"
}
} ],
"links" : { }
}
Get all notes for a case
GET /hubs/{hubId}/cases/{caseId}/notes
Description
Returns a list of case notes for a selected case. Sample query:
GET /hubs/6254/cases/2009631/notes
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
caseId |
The ID of the case |
integer (int32) |
Path |
hubId |
A hub with an Action Management program configured |
integer (int32) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Request is valid, case note returned |
|
404 |
Hub not found, or no Action Management program was found for the hub, or no case was found |
|
408 |
Request timed out |
No Content |
Example HTTP response
Response 200
{
"itemType" : "CaseNote",
"itemCount" : 3,
"totalCount" : 3,
"items" : [ {
"id" : 928745,
"caseId" : 2009631,
"comments" : "This is an example comment you might find on a case note.",
"isSystemGenerated" : false,
"createdBy" : {
"id" : 8790,
"userName" : "exampleUser8790",
"isActive" : true,
"links" : {
"self" : "http://example.org/v1/hubs/96/enduserlists/906/users/8790"
}
},
"modifiedBy" : {
"id" : 8788,
"userName" : "exampleUser8788",
"isActive" : false,
"links" : {
"self" : "http://example.org/v1/hubs/96/enduserlists/906/users/8788"
}
},
"dateCreated" : "2021-05-01T00:00:00+00:00",
"dateModified" : "2021-05-03T00:00:00+00:00",
"links" : {
"self" : "http://example.org/v1/actionmanagement/hubs/96/cases/2009631/notes/928745"
}
}, {
"id" : 928600,
"caseId" : 2009631,
"comments" : "Case created",
"isSystemGenerated" : true,
"dateCreated" : "2021-05-01T00:00:00+00:00",
"links" : {
"self" : "http://example.org/v1/actionmanagement/hubs/96/cases/2009631/notes/928600"
}
}, {
"id" : 928788,
"caseId" : 2009631,
"comments" : "One more example comment",
"isSystemGenerated" : false,
"createdBy" : {
"id" : 9870,
"userName" : "exampleUser9870",
"isActive" : true,
"links" : {
"self" : "http://example.org/v1/hubs/96/enduserlists/906/users/9870"
}
},
"modifiedBy" : {
"id" : 9870,
"userName" : "exampleUser9870",
"isActive" : true,
"links" : {
"self" : "http://example.org/v1/hubs/96/enduserlists/906/users/9870"
}
},
"dateCreated" : "2021-05-03T00:00:00+00:00",
"dateModified" : "2021-05-04T00:00:00+00:00",
"links" : {
"self" : "http://example.org/v1/actionmanagement/hubs/96/cases/2009631/notes/928788"
}
} ],
"links" : { }
}
Get a case note
GET /hubs/{hubId}/cases/{caseId}/notes/{id}
Description
Returns a single case note matching the given case ID and case note ID. Sample query:
GET /hubs/6254/cases/2009631/notes/59325
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
caseId |
The ID of the case |
integer (int32) |
Path |
hubId |
A hub with an Action Management program configured |
integer (int32) |
Path |
id |
The ID of the case note |
integer (int32) |
Get a case
GET /hubs/{hubId}/cases/{id}
Description
Gets a single case matching the given case ID. Sample query:
GET /hubs/6254/cases/2009631
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
hubId |
A hub with an Action Management program configured |
integer (int32) |
Path |
id |
The ID of the case |
integer (int32) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Request is valid, case returned |
|
404 |
Hub not found, or no Action Management program was found for the hub, or no case was found |
|
408 |
Request timed out |
No Content |
Example HTTP response
Response 200
{
"id" : 2009631,
"name" : "Example case",
"workflowId" : 3536,
"cost" : 250,
"isClosed" : false,
"isOverDue" : false,
"triggerId" : 7315,
"triggerName" : "Example trigger",
"dateDue" : "2021-12-31T00:00:00+00:00",
"preOverDueDateTime" : "2021-11-30T00:00:00+00:00",
"postOverDueDateTime" : "2022-01-10T00:00:00+00:00",
"dateCreated" : "2021-10-01T00:00:00+00:00",
"dateModified" : "2021-10-04T00:00:00+00:00",
"listValues" : [ {
"listId" : 23,
"id" : 987,
"name" : "In Progress",
"type" : "status",
"isOpen" : true
}, {
"listId" : 24,
"id" : 876,
"name" : "Critical",
"type" : "severity",
"isHigh" : true
}, {
"listId" : 25,
"id" : 765,
"name" : "Example category 765",
"type" : "category",
"subCategoryId" : 9087,
"subCategoryName" : "Example subcategory 9087"
}, {
"listId" : 27,
"id" : 764,
"name" : "Example custom list item 764",
"type" : "custom"
} ],
"roles" : [ {
"id" : 3456,
"caseId" : 2009631,
"name" : "Case Manager",
"workflowRoleIsActive" : false,
"users" : [ {
"id" : 8790,
"userName" : "exampleUser8790",
"isActive" : true,
"links" : {
"self" : "http://example.org/v1/hubs/96/enduserlists/906/users/8790"
}
}, {
"id" : 8788,
"userName" : "exampleUser8788",
"isActive" : false,
"links" : {
"self" : "http://example.org/v1/hubs/96/enduserlists/906/users/8788"
}
} ]
}, {
"id" : 3457,
"caseId" : 2009631,
"name" : "Watcher",
"workflowRoleIsActive" : false,
"users" : [ {
"id" : 8788,
"userName" : "exampleUser8788",
"isActive" : false,
"links" : {
"self" : "http://example.org/v1/hubs/96/enduserlists/906/users/8788"
}
}, {
"id" : 9870,
"userName" : "exampleUser9870",
"isActive" : true,
"links" : {
"self" : "http://example.org/v1/hubs/96/enduserlists/906/users/9870"
}
} ]
} ],
"dataFields" : [ {
"id" : 5423,
"caseId" : 2009631,
"name" : "Customer Email",
"value" : "example.email@example.org",
"questionName" : "email"
}, {
"id" : 5424,
"caseId" : 2009631,
"name" : "Overall satisfaction",
"value" : "Low",
"questionName" : "q1"
}, {
"id" : 5425,
"caseId" : 2009631,
"name" : "Country",
"value" : "Canada",
"questionName" : "q5"
} ],
"links" : {
"self" : "http://example.org/v1/actionmanagement/hubs/96/cases/2009631",
"notes" : "http://example.org/v1/actionmanagement/hubs/96/cases/2009631/notes"
}
}
Update a case
PUT /hubs/{hubId}/cases/{id}
Description
Updates a single case using the values from the case details request. Sample query:
PUT /hubs/6254/cases/2009631 Note that the following properties cannot be updated: id isClosed isOverDue dateCreated dateModified listValues[*].name listValues[*].type listValues[*].isOpen listValues[*].isHigh listValues[*].subCategoryName roles[*].caseId roles[*].name roles[*].workflowRoleIsActive dataFields source links
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
hubId |
A hub with an Action Management program configured |
integer (int32) |
Path |
id |
The ID of the case |
integer (int32) |
Body |
body |
A case details object containing values that should replace the existing case values |
Delete a case
DELETE /hubs/{hubId}/cases/{id}
Description
Deletes a single case matching the given case ID. Sample query:
DELETE /hubs/6254/cases/2009631
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
hubId |
A hub with an Action Management program configured |
integer (int32) |
Path |
id |
The ID of the case |
integer (int32) |
Get the program lists
GET /hubs/{hubId}/lists
Description
Returns the lists and all list items defined for an Action Management program. A Case can have one or more of these list items selected. Example query:
GET /hubs/6254/lists
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
hubId |
A hub with an Action Management program configured |
integer (int32) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Ok, the request has succeeded. The program list is returned. |
|
400 |
Bad request, the query parameters are not valid. |
|
404 |
Not found, Program list was not found. |
|
408 |
Request timed out |
No Content |
Example HTTP response
Response 200
{
"itemType" : "ProgramList",
"itemCount" : 4,
"totalCount" : 4,
"items" : [ {
"id" : 9423,
"name" : "Status",
"type" : "status",
"lastUpdated" : "2021-03-10T00:00:00+00:00",
"defaultItem" : 11001,
"items" : [ {
"listId" : 9423,
"id" : 11001,
"name" : "Not Started",
"type" : "status",
"isOpen" : true
}, {
"listId" : 9423,
"id" : 11002,
"name" : "In Progress",
"type" : "status",
"isOpen" : true
}, {
"listId" : 9423,
"id" : 11003,
"name" : "Completed",
"type" : "status",
"isOpen" : false
} ],
"links" : { }
}, {
"id" : 9424,
"name" : "Severity",
"type" : "severity",
"lastUpdated" : "2021-03-10T00:00:00+00:00",
"defaultItem" : 11010,
"items" : [ {
"listId" : 9424,
"id" : 11010,
"name" : "Normal",
"type" : "severity",
"isHigh" : false
}, {
"listId" : 9424,
"id" : 11011,
"name" : "Escalated",
"type" : "severity",
"isHigh" : true
}, {
"listId" : 9424,
"id" : 11012,
"name" : "Low priority",
"type" : "severity",
"isHigh" : false
} ],
"links" : { }
}, {
"id" : 9425,
"name" : "Category",
"type" : "category",
"lastUpdated" : "2021-03-10T00:00:00+00:00",
"defaultItem" : 11022,
"items" : [ {
"listId" : 9425,
"id" : 11020,
"name" : "Footwear",
"type" : "category",
"subCategories" : [ {
"listId" : 9425,
"listItemId" : 11020,
"id" : 7710,
"name" : "Athletic Shoes"
}, {
"listId" : 9425,
"listItemId" : 11020,
"id" : 7711,
"name" : "Casual Shoes"
}, {
"listId" : 9425,
"listItemId" : 11020,
"id" : 7710,
"name" : "Boots"
} ]
}, {
"listId" : 9425,
"id" : 11021,
"name" : "Hats",
"type" : "category",
"subCategories" : [ {
"listId" : 9425,
"listItemId" : 11021,
"id" : 7720,
"name" : "Cold Weather Hats"
}, {
"listId" : 9425,
"listItemId" : 11021,
"id" : 7721,
"name" : "Baseball Caps"
} ]
}, {
"listId" : 9424,
"id" : 11022,
"name" : "Accessories",
"type" : "category"
} ],
"links" : { }
}, {
"id" : 9425,
"name" : "Store Location",
"type" : "custom",
"lastUpdated" : "2021-03-10T00:00:00+00:00",
"defaultItem" : 11030,
"items" : [ {
"listId" : 9425,
"id" : 11030,
"name" : "London - Kensington",
"type" : "custom"
}, {
"listId" : 9425,
"id" : 11031,
"name" : "London - Canary Wharf",
"type" : "custom"
}, {
"listId" : 9425,
"id" : 11032,
"name" : "Bristol",
"type" : "custom"
}, {
"listId" : 9425,
"id" : 11033,
"name" : "Glasgow",
"type" : "custom"
} ],
"links" : { }
} ],
"links" : { }
}
Get a paginated list of case notes
GET /hubs/{hubId}/notes
Description
Returns a paginated list of case notes for a hub, sorted by modified date/time in ascending order. All times are UTC. The request must contain a value for either dateModifiedStart or dateModifiedEnd, or both. dateModifiedStart cannot be greater than or equal to dateModifiedEnd. Sample query:
GET /hubs/6254/notes?dateModifiedStart=2022-02-01&dateModifiedEnd=2022-03-01&top=50&skip=100
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
hubId |
A hub with an Action Management program configured |
integer (int32) |
|
Query |
dateModifiedEnd |
Limits the results to notes modified on or before the specified date/time. Default is no limit (null) |
string (date-time) |
|
Query |
dateModifiedStart |
Limits the results to notes modified on or after the specified date/time. Default is no limit (null) |
string (date-time) |
|
Query |
skip |
(optional) The number of items to skip for this request. Default is 0. |
integer (int32) |
|
Query |
top |
(optional) The number of items to return on this request, up to a maximum of 1000. Default is 100. |
integer (int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Request is valid, case note returned |
|
400 |
One or more request parameters are invalid |
|
404 |
Hub not found, or no Action Management program was found for the hub |
|
408 |
Request timed out |
No Content |
Example HTTP response
Response 200
{
"itemType" : "CaseNote",
"itemCount" : 3,
"totalCount" : 3,
"items" : [ {
"id" : 928745,
"caseId" : 2009631,
"comments" : "This is an example comment you might find on a case note.",
"isSystemGenerated" : false,
"createdBy" : {
"id" : 8790,
"userName" : "exampleUser8790",
"isActive" : true,
"links" : {
"self" : "http://example.org/v1/hubs/96/enduserlists/906/users/8790"
}
},
"modifiedBy" : {
"id" : 8788,
"userName" : "exampleUser8788",
"isActive" : false,
"links" : {
"self" : "http://example.org/v1/hubs/96/enduserlists/906/users/8788"
}
},
"dateCreated" : "2021-05-01T00:00:00+00:00",
"dateModified" : "2021-05-03T00:00:00+00:00",
"links" : {
"self" : "http://example.org/v1/actionmanagement/hubs/96/cases/2009631/notes/928745"
}
}, {
"id" : 928600,
"caseId" : 2009631,
"comments" : "Case created",
"isSystemGenerated" : true,
"dateCreated" : "2021-05-01T00:00:00+00:00",
"links" : {
"self" : "http://example.org/v1/actionmanagement/hubs/96/cases/2009631/notes/928600"
}
}, {
"id" : 928788,
"caseId" : 2009631,
"comments" : "One more example comment",
"isSystemGenerated" : false,
"createdBy" : {
"id" : 9870,
"userName" : "exampleUser9870",
"isActive" : true,
"links" : {
"self" : "http://example.org/v1/hubs/96/enduserlists/906/users/9870"
}
},
"modifiedBy" : {
"id" : 9870,
"userName" : "exampleUser9870",
"isActive" : true,
"links" : {
"self" : "http://example.org/v1/hubs/96/enduserlists/906/users/9870"
}
},
"dateCreated" : "2021-05-03T00:00:00+00:00",
"dateModified" : "2021-05-04T00:00:00+00:00",
"links" : {
"self" : "http://example.org/v1/actionmanagement/hubs/96/cases/2009631/notes/928788"
}
} ],
"links" : { }
}
Get the list of user roles
GET /hubs/{hubId}/roles
Description
Returns the list of user roles defined for an Action Management program. Roles are used to assign users to Cases. Example query:
GET /hubs/6754/roles
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
hubId |
A hub with an Action Management program configured |
integer (int32) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Ok, the request has succeeded. The role list is returned. |
|
404 |
Hub not found, or no Action Management program was found for the hub |
|
408 |
Request timed out |
Example HTTP response
Response 200
{
"itemType" : "Role",
"itemCount" : 2,
"totalCount" : 2,
"items" : [ {
"id" : 1,
"name" : "Case Manager",
"lastUpdated" : "2024-10-22T15:41:11.0124002+00:00",
"links" : { }
}, {
"id" : 2,
"name" : "Watcher",
"lastUpdated" : "2024-10-22T15:41:11.0124007+00:00",
"links" : { }
} ],
"links" : { }
}