Skip to main content

Executing a Workflow as a Job​

This operation executes a workflow as a job.

More Details

Path Parameters
  • workflowname string required
Query Parameters
  • outputOnly boolean
Request Body
  • Workflow_StartWorkflow object
  • outputFormat string
  • options object
  • inputs object
  • Input1 string
  • Input2 integer
  • Input3 string
  • client object
  • clientName string
Responses

OK

Schema
  • sessionId string
  • message string
  • processStepId integer
  • dialogType integer
  • jobId integer
  • iconType integer
  • html boolean
  • workflow object
  • workflowName string
  • workflowId integer
  • commCell object
  • _type_ integer
  • commCellName string
  • newName string
  • GUID string
  • commCellId integer
  • csGUID string
  • flags object
  • client object
  • hostName string
  • clientId integer
  • clientName string
  • _type_ integer
  • commCellName string
  • commCellId integer
  • clientGUID string
  • properties object
POST /workflow/:workflowname/action/execute

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
workflowname — path required
outputOnly — query
Content-Type
Body
{

  "Workflow_StartWorkflow": {

    "outputFormat": "string",

    "options": {

      "inputs": {

        "Input1": "string",

        "Input2": 0,

        "Input3": "string"

      }

    },

    "client": {

      "clientName": "string"

    }

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/Workflow/:workflowname/Action/Execute' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "Workflow_StartWorkflow": {
    "outputFormat": "string",
    "options": {
      "inputs": {
        "Input1": "string",
        "Input2": 0,
        "Input3": "string"
      }
    },
    "client": {
      "clientName": "string"
    }
  }
}'