v1

latestOpenAPI 3.1.02026-07-2419782400.4 KB

Jobs

Create job

Requires the JOBADD security role.

post/api/workflow/jobs

Request body

namestring

Name of the job

descriptionstring

Description of the job

deadlinestring

Date of when the job ends

campaignIDstring

Id of the campaign the job is part of

accountableIDstring

Id of the user responsible for the job

presetIDstring

Id of the preset the job should be created from

jobMetapropertiesobject

ID and metaproperty values

Example request

{
  "name": "Job Example",
  "description": "Job Description",
  "deadline": "2018-09-29",
  "campaignID": "00000000-0000-0000-0000-000000000000",
  "accountableID": "00000000-0000-0000-0000-000000000000",
  "presetID": "00000000-0000-0000-0000-000000000000",
  "jobMetaproperties": {
    "00000000-0000-0000-0000-000000000000": "00000000-0000-0000-0000-000000000000"
  },
  "stages": [
    {
      "preset_stage_id": "00000000-0000-0000-0000-000000000000",
      "name": "Review",
      "description": "Awesome description",
      "responsibleGroupID": "00000000-0000-0000-0000-000000000000",
      "responsibleID": "00000000-0000-0000-0000-000000000000",
      "deadline": "2018-09-29"
    }
  ]
}

Response

Job created successfully

statusstring

job_idstring

Example response

{
  "status": "Created",
  "job_id": "00000000-0000-0000-0000-000000000000"
}