REST API - openWorkItem

The table summarizes the REST API - openWorkItem (in ClientService).

Request

Format 
POST <baseurl>/clientservice/open/<id>/<userid>
Path parameters
  • id: ID of the work item to be opened.
  • userid: GUID of the resource that wants to open the work item.
Query parameters
  • version=long (optional, default = -1): Version number of the work item to be opened. If set to -1 or omitted, the latest version of the work item is used.
  • channelid=string (optional, default=openspaceGWTPull_DefaultChannel): Identifier of the channel to which the requesting client application is bound.
  • channeltype=string (optional, default=openspaceChannel): Enumerated value defining the channel type (technology) associated with the specified channelid. For a list of available enumerations, see channeltype enumerations.

    See Identifying the Client Channel in a Service Call for more information.

  • responsetype=string (optional, default = JSON): The only valid response type is JSON.

Response

JSON Returns a JSON representation of the contents of a workResponse element.

Example

Header used in example:

  • Accept: application/json
Request 
POST <baseurl>/clientservice/open/136/B6538346-4EC6-4EB7-8ADD-AC85EA2B43E0
Response 
{
        "xml-fragment":
        {
            "@isSuccessful": "true",
            "payloadModel":
            {
                "@payloadMode": "JSON",
                "serializedPayload": "{items:[{"$param":"IncidentDetails","mode":"IN","$value":[{"summary":"Tree fell on house","details":"Big wind - tree uprooted","dateTime":"2017-02-07T00:00:00","location":"Seattle, WA","postcode":"98776","isPropertyDamage":"true","$type":"com.example.xyzinsurance.IncidentDetails"}]},{"$param":"Name","mode":"IN","$value":[{"title":"MR","firstName":"Billie","middle":"Bob","lastName":"Brady","DOB":"1959-10-20","$type":"com.example.xyzinsurance.Person"}]}]}"
            },
            "workTypeDetail":
            {
                "@uid": "WT__FZd4YGzvEeWcj_kyn107Nw",
                "@version": "1.0.0.20170724144848745",
                "@typePiled": "false",
                "@pilingLimit": "0"
            },
            "presentation":
            {
                "@formIdenitifier": "http://10.129.40.599:8080/bpmresources/1.0.0.20170724144848745/openspaceGWTPull_DefaultChannel/XYZInsurance_Process/XYZInsurance_InitiateClaim/CreateClaim/CreateClaim.gwt.json",
                "@activityName": "CreateClaim",
                "@type": "GWT_FORM",
                "@version": "1.0.0.20170724144848745"
            },
            "workItem":
            {
                "@id": "136",
                "@version": "1"
            }
        }
    }