REST API - saveOpenWorkItem

The table summarizes the REST API - saveOpenWorkItem.

Request

Format
PUT <baseurl>/workitem/saveopen/<id>/<version>
Path parameters
  • id: Unique ID of the work item.
  • version: (Optional) Version of the work item. If not passed, the latest version is used.
Body WorkItemBody element (from the WorkItemManagementService schema)

Can be obtained from the response to openWorkItem.

Response

JSON Returns a JSON representation of the content of the saveOpenWorkItemResponse element.
XML Returns the content of the saveOpenWorkItemResponse element (from the WorkItemManagementService schema)

Example

Request
PUT <baseurl>/workitem/saveopen/4/12
Request body
{
        "workItemBody":
        {
            "dataModel":
            {
                "inputs":
                [
                    {
                        "@name": "ContactPhone",
                        "@type": "String",
                        "@array": "false",
                        "simpleSpec":
                        {
                            "value": "778-677-7888"
                        }
                    },
                    {
                        "@name": "Message",
                        "@type": "String",
                        "@array": "false",
                        "simpleSpec":
                        {
                            "value": "Want to buy a model ZZ-900."
                        }
                    },
                    {
                        "@name": "ContactName",
                        "@type": "String",
                        "@array": "false",
                        "simpleSpec":
                        {
                            "value": "Frank Johnson"
                        }
                    }
                ],
                "inouts":
                {
                    "@name": "Notes",
                    "@type": "String",
                    "@array": "false",
                    "simpleSpec":
                    {
                        "value": "Must be delivered by Saturday."
                    }
                }
            }
        }
    }
Response
    {
        "workItemID":
        {
            "@id": "4",
            "@version": "13"
        }
    }