PUT api/workflows/{id}?action={action}&comment={comment}&editor={editor}&queued={queued}

Update a workflow (run an action, and/or edit the workflow item)

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The ID of the workflow being updated	integer	Required
action	The label of the action to execute (if any)	string	Default value is
comment	The comment to add when executing the action (if any)	string	Default value is
editor	The username (text UID) of the user as whom to run this action (optional)	string	Default value is
queued	The request has come from the API Queue (optional)	boolean	Default value is False

Body Parameters

Any metadata changes to be made (optional)

Collection of MetaField

Name	Description	Type	Additional information
GUID	unique GUID for this field	string	None.
iteration	The iteration (index of parent element)	integer	None.
index	The groupIndex (zero-based row index) of this value	integer	None.
entryGUID	Entry/row GUID for this field	string	None.
label	Field label (note a form may have the same label repeated so GUID is the only safe unique identifier)	string	None.
values	Array of values, most fields will have a single value here but certain fields like checkboxes may have multiple values	Collection of MetaValue	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "GUID": "sample string 1",
    "iteration": 2,
    "index": 3,
    "entryGUID": "sample string 4",
    "label": "sample string 5",
    "values": [
      {
        "value": "sample string 1",
        "attributeid": 2,
        "fileID": 3,
        "userID": 4,
        "userGroupID": 5,
        "associatedItemID": 6,
        "other": true,
        "roleID": 8,
        "matrixID": 9,
        "matrixVersion": "sample string 10",
        "matrixName": "sample string 11",
        "tableGUID": "sample string 12",
        "matrixDisplayName": "sample string 13",
        "groupIdx": 14
      },
      {
        "value": "sample string 1",
        "attributeid": 2,
        "fileID": 3,
        "userID": 4,
        "userGroupID": 5,
        "associatedItemID": 6,
        "other": true,
        "roleID": 8,
        "matrixID": 9,
        "matrixVersion": "sample string 10",
        "matrixName": "sample string 11",
        "tableGUID": "sample string 12",
        "matrixDisplayName": "sample string 13",
        "groupIdx": 14
      }
    ]
  },
  {
    "GUID": "sample string 1",
    "iteration": 2,
    "index": 3,
    "entryGUID": "sample string 4",
    "label": "sample string 5",
    "values": [
      {
        "value": "sample string 1",
        "attributeid": 2,
        "fileID": 3,
        "userID": 4,
        "userGroupID": 5,
        "associatedItemID": 6,
        "other": true,
        "roleID": 8,
        "matrixID": 9,
        "matrixVersion": "sample string 10",
        "matrixName": "sample string 11",
        "tableGUID": "sample string 12",
        "matrixDisplayName": "sample string 13",
        "groupIdx": 14
      },
      {
        "value": "sample string 1",
        "attributeid": 2,
        "fileID": 3,
        "userID": 4,
        "userGroupID": 5,
        "associatedItemID": 6,
        "other": true,
        "roleID": 8,
        "matrixID": 9,
        "matrixVersion": "sample string 10",
        "matrixName": "sample string 11",
        "tableGUID": "sample string 12",
        "matrixDisplayName": "sample string 13",
        "groupIdx": 14
      }
    ]
  }
]

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.