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

Update a workflow with key(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 FormData

Name	Type	Additional information
mandatorySetByDependency	integer	None.
GUID	string	None.
iteration	integer	None.
index	integer	None.
entryGUID	string	None.
label	string	None.
values	Collection of FormValueData	None.
items	Collection of FormData	None.
uploadStatus	string	None.
levelValues	Dictionary of string [key] and FormLevelValues [value]	None.
roleData	Collection of FormRoleData	None.
validationStatus	string	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",
        "matrixValueID": 2,
        "attributeid": 3,
        "fileID": 4,
        "userID": 5,
        "userGroupID": 6,
        "associatedItemID": 7,
        "other": true,
        "roleID": 9,
        "matrixID": 10,
        "matrixVersion": "sample string 11",
        "matrixName": "sample string 12",
        "tableGUID": "sample string 13",
        "matrixDisplayName": "sample string 14",
        "groupIdx": 15,
        "sourceEntryGUID": "sample string 16",
        "optIdx": 17,
        "dispValue": "sample string 18",
        "mapperID": 19,
        "dateSourceValue": "sample string 20",
        "dateSourceValueEnd": "sample string 21",
        "tagID": 22
      },
      {
        "value": "sample string 1",
        "matrixValueID": 2,
        "attributeid": 3,
        "fileID": 4,
        "userID": 5,
        "userGroupID": 6,
        "associatedItemID": 7,
        "other": true,
        "roleID": 9,
        "matrixID": 10,
        "matrixVersion": "sample string 11",
        "matrixName": "sample string 12",
        "tableGUID": "sample string 13",
        "matrixDisplayName": "sample string 14",
        "groupIdx": 15,
        "sourceEntryGUID": "sample string 16",
        "optIdx": 17,
        "dispValue": "sample string 18",
        "mapperID": 19,
        "dateSourceValue": "sample string 20",
        "dateSourceValueEnd": "sample string 21",
        "tagID": 22
      }
    ],
    "items": [],
    "uploadStatus": "sample string 6",
    "levelValues": {
      "sample string 1": {
        "GUID": "sample string 1",
        "label": "sample string 2",
        "values": [
          {
            "value": "sample string 1",
            "matrixValueID": 2,
            "attributeid": 3,
            "fileID": 4,
            "userID": 5,
            "userGroupID": 6,
            "associatedItemID": 7,
            "other": true,
            "roleID": 9,
            "matrixID": 10,
            "matrixVersion": "sample string 11",
            "matrixName": "sample string 12",
            "tableGUID": "sample string 13",
            "matrixDisplayName": "sample string 14",
            "groupIdx": 15,
            "sourceEntryGUID": "sample string 16",
            "optIdx": 17,
            "dispValue": "sample string 18",
            "mapperID": 19,
            "dateSourceValue": "sample string 20",
            "dateSourceValueEnd": "sample string 21",
            "tagID": 22
          },
          {
            "value": "sample string 1",
            "matrixValueID": 2,
            "attributeid": 3,
            "fileID": 4,
            "userID": 5,
            "userGroupID": 6,
            "associatedItemID": 7,
            "other": true,
            "roleID": 9,
            "matrixID": 10,
            "matrixVersion": "sample string 11",
            "matrixName": "sample string 12",
            "tableGUID": "sample string 13",
            "matrixDisplayName": "sample string 14",
            "groupIdx": 15,
            "sourceEntryGUID": "sample string 16",
            "optIdx": 17,
            "dispValue": "sample string 18",
            "mapperID": 19,
            "dateSourceValue": "sample string 20",
            "dateSourceValueEnd": "sample string 21",
            "tagID": 22
          }
        ]
      },
      "sample string 2": {
        "GUID": "sample string 1",
        "label": "sample string 2",
        "values": [
          {
            "value": "sample string 1",
            "matrixValueID": 2,
            "attributeid": 3,
            "fileID": 4,
            "userID": 5,
            "userGroupID": 6,
            "associatedItemID": 7,
            "other": true,
            "roleID": 9,
            "matrixID": 10,
            "matrixVersion": "sample string 11",
            "matrixName": "sample string 12",
            "tableGUID": "sample string 13",
            "matrixDisplayName": "sample string 14",
            "groupIdx": 15,
            "sourceEntryGUID": "sample string 16",
            "optIdx": 17,
            "dispValue": "sample string 18",
            "mapperID": 19,
            "dateSourceValue": "sample string 20",
            "dateSourceValueEnd": "sample string 21",
            "tagID": 22
          },
          {
            "value": "sample string 1",
            "matrixValueID": 2,
            "attributeid": 3,
            "fileID": 4,
            "userID": 5,
            "userGroupID": 6,
            "associatedItemID": 7,
            "other": true,
            "roleID": 9,
            "matrixID": 10,
            "matrixVersion": "sample string 11",
            "matrixName": "sample string 12",
            "tableGUID": "sample string 13",
            "matrixDisplayName": "sample string 14",
            "groupIdx": 15,
            "sourceEntryGUID": "sample string 16",
            "optIdx": 17,
            "dispValue": "sample string 18",
            "mapperID": 19,
            "dateSourceValue": "sample string 20",
            "dateSourceValueEnd": "sample string 21",
            "tagID": 22
          }
        ]
      }
    },
    "roleData": [
      {
        "rate": 1.1,
        "role": "sample string 2",
        "roleID": 3,
        "userID": 4,
        "value": "sample string 5"
      },
      {
        "rate": 1.1,
        "role": "sample string 2",
        "roleID": 3,
        "userID": 4,
        "value": "sample string 5"
      }
    ],
    "validationStatus": "sample string 7",
    "mandatorySetByDependency": 1
  },
  {
    "GUID": "sample string 1",
    "iteration": 2,
    "index": 3,
    "entryGUID": "sample string 4",
    "label": "sample string 5",
    "values": [
      {
        "value": "sample string 1",
        "matrixValueID": 2,
        "attributeid": 3,
        "fileID": 4,
        "userID": 5,
        "userGroupID": 6,
        "associatedItemID": 7,
        "other": true,
        "roleID": 9,
        "matrixID": 10,
        "matrixVersion": "sample string 11",
        "matrixName": "sample string 12",
        "tableGUID": "sample string 13",
        "matrixDisplayName": "sample string 14",
        "groupIdx": 15,
        "sourceEntryGUID": "sample string 16",
        "optIdx": 17,
        "dispValue": "sample string 18",
        "mapperID": 19,
        "dateSourceValue": "sample string 20",
        "dateSourceValueEnd": "sample string 21",
        "tagID": 22
      },
      {
        "value": "sample string 1",
        "matrixValueID": 2,
        "attributeid": 3,
        "fileID": 4,
        "userID": 5,
        "userGroupID": 6,
        "associatedItemID": 7,
        "other": true,
        "roleID": 9,
        "matrixID": 10,
        "matrixVersion": "sample string 11",
        "matrixName": "sample string 12",
        "tableGUID": "sample string 13",
        "matrixDisplayName": "sample string 14",
        "groupIdx": 15,
        "sourceEntryGUID": "sample string 16",
        "optIdx": 17,
        "dispValue": "sample string 18",
        "mapperID": 19,
        "dateSourceValue": "sample string 20",
        "dateSourceValueEnd": "sample string 21",
        "tagID": 22
      }
    ],
    "items": [],
    "uploadStatus": "sample string 6",
    "levelValues": {
      "sample string 1": {
        "GUID": "sample string 1",
        "label": "sample string 2",
        "values": [
          {
            "value": "sample string 1",
            "matrixValueID": 2,
            "attributeid": 3,
            "fileID": 4,
            "userID": 5,
            "userGroupID": 6,
            "associatedItemID": 7,
            "other": true,
            "roleID": 9,
            "matrixID": 10,
            "matrixVersion": "sample string 11",
            "matrixName": "sample string 12",
            "tableGUID": "sample string 13",
            "matrixDisplayName": "sample string 14",
            "groupIdx": 15,
            "sourceEntryGUID": "sample string 16",
            "optIdx": 17,
            "dispValue": "sample string 18",
            "mapperID": 19,
            "dateSourceValue": "sample string 20",
            "dateSourceValueEnd": "sample string 21",
            "tagID": 22
          },
          {
            "value": "sample string 1",
            "matrixValueID": 2,
            "attributeid": 3,
            "fileID": 4,
            "userID": 5,
            "userGroupID": 6,
            "associatedItemID": 7,
            "other": true,
            "roleID": 9,
            "matrixID": 10,
            "matrixVersion": "sample string 11",
            "matrixName": "sample string 12",
            "tableGUID": "sample string 13",
            "matrixDisplayName": "sample string 14",
            "groupIdx": 15,
            "sourceEntryGUID": "sample string 16",
            "optIdx": 17,
            "dispValue": "sample string 18",
            "mapperID": 19,
            "dateSourceValue": "sample string 20",
            "dateSourceValueEnd": "sample string 21",
            "tagID": 22
          }
        ]
      },
      "sample string 2": {
        "GUID": "sample string 1",
        "label": "sample string 2",
        "values": [
          {
            "value": "sample string 1",
            "matrixValueID": 2,
            "attributeid": 3,
            "fileID": 4,
            "userID": 5,
            "userGroupID": 6,
            "associatedItemID": 7,
            "other": true,
            "roleID": 9,
            "matrixID": 10,
            "matrixVersion": "sample string 11",
            "matrixName": "sample string 12",
            "tableGUID": "sample string 13",
            "matrixDisplayName": "sample string 14",
            "groupIdx": 15,
            "sourceEntryGUID": "sample string 16",
            "optIdx": 17,
            "dispValue": "sample string 18",
            "mapperID": 19,
            "dateSourceValue": "sample string 20",
            "dateSourceValueEnd": "sample string 21",
            "tagID": 22
          },
          {
            "value": "sample string 1",
            "matrixValueID": 2,
            "attributeid": 3,
            "fileID": 4,
            "userID": 5,
            "userGroupID": 6,
            "associatedItemID": 7,
            "other": true,
            "roleID": 9,
            "matrixID": 10,
            "matrixVersion": "sample string 11",
            "matrixName": "sample string 12",
            "tableGUID": "sample string 13",
            "matrixDisplayName": "sample string 14",
            "groupIdx": 15,
            "sourceEntryGUID": "sample string 16",
            "optIdx": 17,
            "dispValue": "sample string 18",
            "mapperID": 19,
            "dateSourceValue": "sample string 20",
            "dateSourceValueEnd": "sample string 21",
            "tagID": 22
          }
        ]
      }
    },
    "roleData": [
      {
        "rate": 1.1,
        "role": "sample string 2",
        "roleID": 3,
        "userID": 4,
        "value": "sample string 5"
      },
      {
        "rate": 1.1,
        "role": "sample string 2",
        "roleID": 3,
        "userID": 4,
        "value": "sample string 5"
      }
    ],
    "validationStatus": "sample string 7",
    "mandatorySetByDependency": 1
  }
]

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'.

application/scim+json

Sample:

An exception has occurred while using the formatter 'SCIMMediaTypeFormatter' to generate sample for media type 'application/scim+json'. Exception message: Self referencing loop detected with type 'SDAPI.FormData'. Path '[0].items'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/scim+json

Sample:

Sample not available.