REST API - openNextWorkItem

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

Request

Format 
POST <baseurl>/clientservice/open/next/<userid>
Path parameters userid: GUID of the resource that wants to open the next work item.
Query parameters
  • 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.

  • worklistviewid=long (optional, default = -1): Identifier of the work list view associated with this work item, used to determine which work item to retrieve.
  • 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

Headers used in example:

  • Accept: application/json
Request 
POST <baseurl>/clientservice/open/next/8C8AD3FD-3600-4E7D-9DF4-0280F8506635
Response 
{
        "xml-fragment":
        {
            "@isSuccessful": "true",
            "payloadModel":
            {
                "@payloadMode": "JSON",
                "serializedPayload": "{items:[{"$param":"IssueDescription","$value":["Needs some training on E440."],"type":"String","mode":"IN"},{"$param":"IssueDetails","$value":["Schedule training in September."],"type":"String","mode":"IN"},{"$param":"ResolutionDescription","$value":[],"type":"String","mode":"INOUT"},{"$param":"ResolutionDetails","$value":[],"type":"String","mode":"INOUT"}]}"
            },
            "workTypeDetail":
            {
                "@uid": "WT__18B00F61Ed-KqJmYNEw8ow",
                "@version": "1.0.0.201306101420",
                "@typePiled": "false",
                "@pilingLimit": "0"
            },
            "presentation":
            {
                "@formIdenitifier": "http://10.129.40.599:8080/bpmresources/1.0.0.201306101420/openspaceGWTPull_DefaultChannel/HelpDesk/HelpDeskProcess/IT/IT.gwt.json",
                "@activityName": "IT",
                "@type": "GWT_FORM",
                "@version": "1.0.0.201306101420"
            },
            "workItem":
            {
                "@id": "3",
                "@version": "1"
            }
        }
    }