/createaction

V1.0

Description

Creates a completed action in the What’s Done area; also completes a relevant outstanding task if present on the case.

A CaseId or ExternalId must be provided alongside a Type.

On submission of this request, a submission form as specified by the Type parameter will be presented in the What’s Done area.

A task code can be provided as the value for the Task parameter; this will complete an outstanding task (with this same task code) on the case. If there isn't a relevant outstanding task in the What’s next area for the case, then the request will result in a HTTP: 400 Bad Request: X-Application-Error-Code: 1003 or HTTP: 400 Bad Request: X-Application-Error-Code: 1004 response.

In addition to the parameters described below, this API can be extended by the inclusion of fields on the form to be actioned, and action attributes. Please consult iCasework support for the correct notation for these fields.

Request Method

POST

API Service endpoints

UAT: https://uat.icasework.com/createaction?db=[youriCaseworkAccount]
eUAT / Production system: https://[youriCaseworkAccount].icasework.com/createaction

Your iCasework account name will be supplied to you by your iCasework Account or Project Manager

Request Parameters

Parameter	Description	Example Input	Required value?

Parameter	Description	Example Input	Required value?
CaseId	The iCasework identifier for the case on which you wish to act.	"1624234"	No.
ExternalId	The external identifier for the case on which you wish to act.	“EXT243A-C”	No.
Type	The ID or synonym for the form you wish to submit. Please contact your iCasework representative for the exact codes to use for your configuration.	"UF123511"	Yes.
Task	The task code for an outstanding task to be completed. Please contact your iCasework representative for the exact codes to use for your configuration.	"INBOUNDCALL"	No.
Format	Defines the format of the API response. The default value is "xml"	"xml" or "json"	No.

Example

Request

<https://example.icasework.com/createaction>

<?xml version="1.0" encoding="UTF-8" ?>
<CaseId>1235151</CaseId>
<Type>UF12435</Type>
<Task>INBOUNDCALL</Task>

{
 "CaseId": "1235151",
 "Type":"UF12435",
 "Task":"INBOUNDCALL",
 "Format":"json"
}

Response

<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<createactionresponse>
 <actionid>1346721</actionid>
</createactionresponse>

{"createactionresponse":
  {
   "actionid": "1346721"
  }
}

HTTP 400 responses

X-Application-Error-Code	X-Application-Error-Info	Troubleshooting tips

X-Application-Error-Code	X-Application-Error-Info	Troubleshooting tips
1000	Invalid HTTP Method	Check the HTTP method; this should be a POST
1001	Parameter Type is required	Include `Type` parameter in the request
1002	Parameter CaseId or parameter ExternalId is required.	Include `CaseId` or `ExternalId` parameter in the request
1003	Unable to identify task	Check that the values for `CaseId` or `ExternalId`; and `Task` are valid
1004	Task has already been completed	No tasks with a task code equal to `Task` are outstanding on this case with a reference equal to `CaseId`; but a relevant task was completed on this case
1099	Various	There was an issue with uploading the form; check the `X-Application-Error-Info` response header

HTTP 403 responses

X-Application-Error-Code	X-Application-Error-Info	Troubleshooting tips

X-Application-Error-Code	X-Application-Error-Info	Troubleshooting tips
1021	Incorrect key or signature	Check the authentication method of the request
1021	Invalid token (6)	Check the authentication method of the request
1022	Insufficient privileges for updating customer details	Check that there is a user associated with the API key

createaction