OpenText Cordys 10.6 documentation : UpdateCase Variables

UpdateCase Variables

This API is used to update the Case variables of a specific Case instance.

Resource URI
v1/cases/{modelid}/instances/{caseInstanceId}/variables
Request Type

HTTP POST

HTTP Header Parameters

Parameter

Description

Accepted Input Values

SAMLart

 The SAML artifact that is received after authentication.

For more information on how to authenticate, see Login.
otdsticket The OTDSTicket received after authentication from OTDS. The OTDSTicket must be provided as a header parameter. For more information on how to authenticate, see Login.

Note : You must provide either SAMLart or otdsticket header parameter. If you provide both the header parameters, it will internally work based on SAMLart.

Request Parameters
Parameter Description Accepted Input Values

modelid

 The model ID of the Case. For example, if the model ID qname is com/opentext/conference/ProductLaunch then in the URL it must be provided as com.opentext.conference.ProductLaunch .

caseInstanceId

 The instance ID of the Case instance.  
HTTP Payload

The POST accepts the payload content only in the XML format. The request format is as follows:

Sample POST Request
<case_data xmlns="http://schemas.cordys.com/casemanagement/execution/1.0" lockID="cb810b7b-df6e-11e3-e96b-54308f42dd76">
    <data name="casevariables">
        <casevariables>
            <cv1 type="string">Purchase</cv1>
            <cv2 type="string">Manager</cv2>
        </casevariables>
    </data>
</case_data>
Request Parameters

Parameter

Description

Mandatory

Accepted Input Values

case_data

Refers to the container of the Case instance that holds the data of Case variables, Case identifiers, and Case models

Yes

  

lockID

Indicates the optimistic lock ID of the Case variables data read from the database. This value is available in the response of the GetCaseVariables Web service.

Yes

  

casevariables

Indicates the optimistic lock ID of the Case variables data read from the database. This value is available in the response of the GetCaseVariables Web service.

Yes

Values of the Case variables to be updated
Sample Response
<UpdateCaseVariablesResponse>
    <case_instance_id>5f15319f-1b44-11e3-e955-fa8c8a9a9d41</case_instance_id>
    <current_state>9f17e09e-0ed9-11e3-e8ba-cf22fd22db4e</current_state>
</UpdateCaseVariablesResponse>