Summary
          Start a Job with Options
          Description
          Initiate a Job of a Workflow with options.
          Route
          POST /workflow_engine/startJobWithOptions/:workflow
          Roles
          
            admin
engineering
support
apiwrite
          
          Parameters
          
            DetailsExampleSchema
          
          
            
              
                | Name | Type | Required | Description | 
            
            
              
    | workflow | string | yes | Name of the workflow from which to start the Job. | 
    | options | object | yes | Options for the Job | 
            
          
          
            Copied to Clipboard
            
            {
  "options": {
    "description": "Example job description",
    "type": "Automation",
    "groups": [
      "5cb7b531d06cceb89fd21b1c",
      "4321abcdef694aa79dae47ad",
      "5cb7b531d06cceb89fd21b1c"
    ]
  }
}
           
          
            Copied to Clipboard
            
            {
  "type": "object",
  "properties": {
    "options": {
      "type": "object",
      "description": "Options for the Job",
      "properties": {
        "description": {
          "type": "string",
          "description": "The description for the job to be started",
          "examples": [
            "Example job description"
          ]
        },
        "type": {
          "type": "string",
          "examples": [
            "Automation"
          ]
        },
        "variables": {
          "$ref": "jobsDocument#/definitions/variables"
        },
        "groups": {
          "type": "array",
          "description": "Groups available for job",
          "items": {
            "$ref": "wfEngineCommon#/definitions/mongoObjectId"
          }
        }
      }
    }
  },
  "required": [
    "options"
  ],
  "additionalProperties": false
}
           
          Return
          
            DetailsExampleSchema
          
          
            
              
                | Name | Type | Description | 
            
            
              
                | save_data | object | Job which is started. | 
            
          
          
            Copied to Clipboard
            
            {
  "_id": "4430ceadbd694aa79994ad47",
  "name": "8917Test2",
  "tasks": {
    "workflow_start": {
      "name": "workflow_start",
      "groups": [],
      "x": 0.08412582297000731,
      "y": 0.4968944099378882,
      "status": "complete",
      "metrics": {
        "owner": "Pronghorn",
        "start_time": 1555430149763,
        "end_time": 1555430169683,
        "run_time": 75069184,
        "finish_state": "canceled",
        "server_id": "ac:de:48:00:11:22:3000",
        "app": {
          "id": "WorkFlowEngine",
          "version": "1.2.3"
        }
      }
    },
    "workflow_end": {
      "name": "workflow_end",
      "groups": [],
      "x": 0.08412582297000731,
      "y": 0.4968944099378882,
      "status": "complete",
      "metrics": {
        "owner": "Pronghorn",
        "start_time": 1555430149763,
        "end_time": 1555430169683,
        "run_time": 75069184,
        "finish_state": "error",
        "server_id": "ac:de:48:00:11:22:3000",
        "app": {
          "id": "WorkFlowEngine",
          "version": "1.2.3"
        }
      }
    }
  },
  "transitions": {
    "workflow_start": {
      "6a90": {
        "type": "standard",
        "state": "success"
      }
    },
    "6a90": {
      "workflow_end": {
        "type": "standard",
        "state": "success"
      }
    }
  },
  "font_size": 12,
  "created": "2018-07-26T19:37:05.000Z",
  "created_by": "admin@pronghorn",
  "last_updated": "2018-08-02T15:56:12.912Z",
  "last_updated_by": "5b3496d74da02e9dfa0b2e91",
  "groups": [],
  "type": "automation",
  "watchers": [
    "4321abcdef694aa79dae47ad",
    "4321abcdef694aa79dae47ad"
  ],
  "metrics": {
    "owner": "Pronghorn",
    "start_time": 1555430149763,
    "end_time": 1555430169683,
    "run_time": 75069184,
    "finish_state": "canceled",
    "server_id": "ac:de:48:00:11:22:3000",
    "app": {
      "id": "MOP",
      "version": "3.2.1"
    }
  },
  "status": "error",
  "locked": false,
  "error": [
    {
      "task": "job",
      "message": "No available transitions found from completed task(s)",
      "timestamp": 1555471643117
    },
    {
      "task": "job",
      "message": "No available transitions found from completed task(s)",
      "timestamp": 1555471643117
    },
    {
      "task": "job",
      "message": "No available transitions found from completed task(s)",
      "timestamp": 1555471643117
    },
    {
      "task": "job",
      "message": "No available transitions found from completed task(s)",
      "timestamp": 1555471643117
    }
  ]
}