Workflow

PATCH /ver2/WorkflowService.svc/workflows/{workflowIdOrUniqueId}/steps/{stepIdOrName}

Updates one or more values in the Form Fields of an existing Workflow Step. Any Form Fields not specified are left un-modified. A Step Action to invoke may also be specified, which will move (transition) the Workflow from the current Step to the destination Step of the Step Action.

Security: Allowed for Users with Manage Workflows right or "Report" permission on the Workflow, or User in "Workflow Managers" role of WF, or User with "Manage Workflows" on any objects associated with the workflow.

SDK API: envianceSdk.workflows.updateWorkflowStep(workflowIdOrUniqueId, stepIdOrName, stepInfo, onsuccess, onerror)

<div class="code">
<pre>
PATCH /ver2/WorkflowService.svc/workflows/7ef9655e-916b-414f-8c88-5753fa731558 HTTP/1.1
Content-Type: application/json; charset=UTF-8
 
{
  "workflowInfo": {
    "dueDate": "2012-09-19T18:00:00",
    "name": "test",
    "objects": ["/Generation - 1/NE TV"],
    "documents": ["/Folder/Folder/Doc.txt"]
  }
}

envianceSdk.workflows.updateWorkflowStep

[
  "22cf40b5-b001-47ce-8853-020dc9e9aa8e",
  "Oleg FT Step1",
  {
    "comment": "my comment",
    "transition": {
      "dueDate": "2013-02-15T00:00:00",
      "stepActionName": "Oleg FT Step1 Action1",
      "assignTo": [
        {
          "userIdOrName": "oleg"
        },
        {
          "userIdOrName": "vitek"
        },
        {
          "groupIdOrName": "Administrators"
        },
        {
          "groupIdOrName": "BL Group"
        }
      ]
    },
    "fields": [
      {
        "name": "Oleg FT 1 = dt date",
        "values": [
          "2013-02-01T00:00:00"
        ]
      },
      {
        "name": "Oleg FT 1 = url",
        "urlItems": [
          {
            "label": "may label",
            "url": "http://mail.ru"
          }
        ]
      },
      {
        "name": "oleg FT 1 = num ddl linked 2",
        "values": [
          "100",
          "100"
        ]
      },
      {
        "name": "oleg FT 1 = text multi",
        "values": [
          "val1",
          "val3"
        ]
      }
    ]
  },
  "onsuccess",
  "onerror"
]

envianceSdk.workflows.updateWorkflowStepExt

[
  {
    "workflowIdOrUniqueId": "22cf40b5-b001-47ce-8853-020dc9e9aa8e",
    "stepIdOrName": "Oleg FT Step1",
    "stepInfo": {
      "comment": "my comment",
      "transition": {
        "dueDate": "2013-02-15T00:00:00",
        "stepActionName": "Oleg FT Step1 Action1",
        "assignTo": [
          {
            "userIdOrName": "oleg"
          },
          {
            "userIdOrName": "vitek"
          },
          {
            "groupIdOrName": "Administrators"
          },
          {
            "groupIdOrName": "BL Group"
          }
        ]
      },
      "fields": [
        {
          "name": "Oleg FT 1 = dt date",
          "values": [
            "2013-02-01T00:00:00"
          ]
        },
        {
          "name": "Oleg FT 1 = url",
          "urlItems": [
            {
              "label": "may label",
              "url": "http://mail.ru"
            }
          ]
        },
        {
          "name": "oleg FT 1 = num ddl linked 2",
          "values": [
            "100",
            "100"
          ]
        },
        {
          "name": "oleg FT 1 = text multi",
          "values": [
            "val1",
            "val3"
          ]
        }
      ]
    },
    "clientRequestId": "64AA5290-15F2-451B-9EF3-4494F66FE59E"
  },
  "onsuccess",
  "onerror"
]

Request

Path parameters

workflowIdOrUniqueIdstring required
stepIdOrNamestring required

Headers

EnvApi-Systemidstring

Specify specific system to run instead of Home

EnvApi-Packageidstring

(optional) Clients application/package ID

EnvApi-Udf-DateTime-Iso-In-CustomFieldsstring

Udfs of DateTime should use Iso

EnvApi-Udf-DateTime-ReadInUserTzstring

(obsolete) Udfs of DateTime type whould be in ReadInUserTz

EnvApi-Udf-Value-Invariantstring

(optional) Udfs - Force Non-Localized (invariant) values

EnvApi-Localization-Allstring

(optional) Extend objects with User-given Localizations

x-client-request-idstring

(optional) Client ID for double submit prevention

Request body

Response

not available

Changes

No recorded changes to this operation across all 1 revision of this API.