POST Agents/Workflow/SaveWorkflowWaitForAction

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/Workflow/SaveWorkflowWaitForAction

Updates the existing WorkflowWaitForAction or creates a new WorkflowWaitForAction if the id parameter is 0.

NsApiSlow threshold: 1000 ms.

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: workflowWaitForAction

The WorkflowWaitForAction that is saved

Property Name Type Description
WorkflowWaitForActionId Integer Primary key
WorkflowStepId Integer The workflow step this instance belongs to
WorkflowId Integer Workflow id
Rank Integer The rank of this action
ActionType String The type of action
RestrictionGroups Array The restrictions (can be multiple groups) that make up the Workflow action criteria

Response:

OK

Response Description
200 OK

Response body: WorkflowWaitForAction

Property Name Type Description
WorkflowWaitForActionId int32 Primary key
WorkflowStepId int32 The workflow step this instance belongs to
WorkflowId int32 Workflow id
Rank int32 The rank of this action
ActionType string The type of action
RestrictionGroups array The restrictions (can be multiple groups) that make up the Workflow action criteria
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/Workflow/SaveWorkflowWaitForAction
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: fr,de,ru,zh
Content-Type: application/json; charset=utf-8

{
  "WorkflowWaitForActionId": 423,
  "WorkflowStepId": 963,
  "WorkflowId": 607,
  "Rank": 437,
  "ActionType": "FormSubmitted",
  "RestrictionGroups": [
    {
      "Name": "Hettinger-Wolf",
      "Description": "Multi-lateral directional protocol",
      "Rank": 63,
      "Restrictions": [
        {},
        {}
      ]
    },
    {
      "Name": "Hettinger-Wolf",
      "Description": "Multi-lateral directional protocol",
      "Rank": 63,
      "Restrictions": [
        {},
        {}
      ]
    }
  ]
}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "WorkflowWaitForActionId": 525,
  "WorkflowStepId": 908,
  "WorkflowId": 172,
  "Rank": 144,
  "ActionType": "FormSubmitted",
  "RestrictionGroups": [
    {
      "Name": "Kiehn, Lindgren and Jones",
      "Description": "Organized optimizing archive",
      "Rank": 134,
      "Restrictions": [
        {},
        {}
      ]
    },
    {
      "Name": "Kiehn, Lindgren and Jones",
      "Description": "Organized optimizing archive",
      "Rank": 134,
      "Restrictions": [
        {},
        {}
      ]
    }
  ],
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 391
    }
  }
}