Workflow

POST /ver2/WorkflowService.svc/workflows/{workflowIdOrUniqueId}/children

Executes a Workflow Initiator action on the active Step of an existing Workflow, thereby creating a new child Workflow, and places the child on its Init Step. Information about Form Field values and Step Actions may optionally be specified in order to update or take action on the Init Step of the child Workflow.

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.initiateChildWorkflow(workflowIdOrUniqueId, childWorkflowInitiationInfo, onsuccess, onerror) null

envianceSdk.workflows.initiateChildWorkflow

[
  "B5E7E7A4-D294-4D7C-ABC9-008EDBE97346",
  {
    "parentStepIdOrName": "Step1",
    "initiatorIdOrName": "fc621b5a-739f-4cb7-9635-cb9d17f4cef6",
    "childWorkflowInfo": {
      "dueDate": "2012-09-19T18:00:00",
      "parentWorkflowSourceCustomField": {
        "id": null,
        "name": "UDF name"
      },
      "name": "test",
      "uniqueId": "1347398349600",
      "objects": [
        "/Generation - 1/NE TV"
      ]
    }
  },
  "onsuccess",
  "onerror"
]

envianceSdk.workflows.initiateChildWorkflow21

[
  "B5E7E7A4-D294-4D7C-ABC9-008EDBE97346",
  {
    "parentStepIdOrName": "Step1",
    "initiatorIdOrName": "fc621b5a-739f-4cb7-9635-cb9d17f4cef6",
    "childWorkflowInfo": {
      "dueDate": "2012-09-19T18:00:00",
      "parentWorkflowSourceCustomField": {
        "id": null,
        "name": "UDF name"
      },
      "name": "test",
      "uniqueId": "1347398349600",
      "objects": [
        "/Generation - 1/NE TV"
      ],
      "documents": [
        {
          "documentIdOrPath": "Folder1Document1.txt"
        },
        {
          "documentIdOrPath": "Folder1Document2.txt",
          "customFieldIdOrName": "udf-textbox-numeric"
        }
      ]
    }
  },
  "onsuccess",
  "onerror"
]

envianceSdk.workflows.initiateChildWorkflow21Ext

[
  {
    "workflowIdOrUniqueId": "B5E7E7A4-D294-4D7C-ABC9-008EDBE97346",
    "childWorkflowInitiationInfo": {
      "parentStepIdOrName": "Step1",
      "initiatorIdOrName": "fc621b5a-739f-4cb7-9635-cb9d17f4cef6",
      "childWorkflowInfo": {
        "dueDate": "2012-09-19T18:00:00",
        "parentWorkflowSourceCustomField": {
          "id": null,
          "name": "UDF name"
        },
        "name": "test",
        "uniqueId": "1347398349600",
        "objects": [
          "/Generation - 1/NE TV"
        ],
        "documents": [
          {
            "documentIdOrPath": "Folder1Document1.txt"
          },
          {
            "documentIdOrPath": "Folder1Document2.txt",
            "customFieldIdOrName": "udf-textbox-numeric"
          }
        ]
      }
    },
    "clientRequestId": "64AA5290-15F2-451B-9EF3-4494F66FE48F"
  },
  "onsuccess",
  "onerror"
]

envianceSdk.workflows.initiateChildWorkflowExt

[
  {
    "workflowIdOrUniqueId": "eccd2310-9b5f-440b-bf0d-91f9803d036b",
    "childWorkflowInitiationInfo": {
      "parentStepIdOrName": "Step1",
      "initiatorIdOrName": "fc621b5a-739f-4cb7-9635-cb9d17f4cef6",
      "childWorkflowInfo": {
        "dueDate": "2012-09-19T18:00:00",
        "parentWorkflowSourceCustomField": {
          "id": null,
          "name": "UDF name"
        },
        "name": "test",
        "uniqueId": "1347398349600",
        "objects": [
          "/Generation - 1/NE TV"
        ]
      }
    },
    "clientRequestId": "64AA5290-15F2-451B-9EF3-4494F66FE59E"
  },
  "onsuccess",
  "onerror"
]

Request

Path parameters

workflowIdOrUniqueIdstring 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

string guid required

Changes

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