POST v1/jobs-queue/{environment}/{orgId}

Use this method to create a system queue job, as a one off, scheduled, or recurrent job.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
environment

Environment where the org was created.

 string

Required
orgId

Org for which to return created jobs.

 integer

Required

Body Parameters

CreateJobModel
NameDescriptionTypeAdditional information
typeId

Type job to use as a template, this value is required in order to create any kind of job.

 string

None.
appId

Optional MaaS Application id for which the job should run. Don't send a value if this is a job not targeting an application.

 integer

None.
venue

Optional Property/Venue for which the job should run, If this is not a venue job there is no need to send any value.

 string

None.
settings

Job settings to override from user input when creating the job.

 Collection of QueueJobSetting

None.
schedule

Optional Date and time in UTC (Universal time format) for which the job should be scheduled. If you which to run this job immediately don't send this parameter.

 date

None.
interval

Optional interval in seconds between recurrent job execution cycles. This parameter will be ignored if the job "JS: recurrent, C#: IsRecurrent" property is set to false. To set a job as recurrent, set its "JS: recurrent, C#: IsRecurrent" property to true.

 integer

None.
name

Friendly job display name.

 string

None.
recurrent

Optional parameter to set a job to be recurrent, or not, the default value is false (not recurrent)

 boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "typeId": "sample string 1",
  "appId": 1,
  "venue": "sample string 2",
  "settings": [
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "value": "sample string 7",
      "label": "sample string 8",
      "extraLabel": "sample string 9",
      "step": 10,
      "isTemplate": true
    },
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "value": "sample string 7",
      "label": "sample string 8",
      "extraLabel": "sample string 9",
      "step": 10,
      "isTemplate": true
    }
  ],
  "schedule": "2025-12-12T21:34:14.1642746-08:00",
  "interval": 1,
  "name": "sample string 3",
  "recurrent": true
}

Response Information

Resource Description

QueueJobModel
NameDescriptionTypeAdditional information
id

Queue UUID

 string

None.
entity

Entity

None.
settings

Collection of sys queue items

 Collection of QueueJobSetting

None.
type

Queue type

 QueueJobType

None.
created

Created date-time

 date

None.
updated

Updated date-time

 date

None.
status

Status UUID

 QueueJobStatus

None.
log

List of entries for each cycle the job has run for.

 Collection of QueueJobLogEntry

None.
name

Job Custom display name.

 string

None.
schedule

Scheduled date and time when to run this job. If null or in the past, the system will run the job as soon as is picked up by the "System Queue".

 date

None.
favorite

Set to true if the job is a favorite job.

 boolean

None.
recurrent

Use this property to mark a job as been recurrent. This property will automatically be set to false if interval is not provided or less than 1.

 boolean

None.
interval

Recurrence interval used for recurrent jobs in seconds. Recurrence is a hint to the system queue, but ultimately is governed by the cycle interval internal to the system queue. If the system queue cycle interval is set to say one minute. Setting a job interval to less than one minute will simply cause the job to be run on every cycle.

 integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "id": "sample string 1",
  "entity": {
    "type": 1
  },
  "settings": [
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "value": "sample string 7",
      "label": "sample string 8",
      "extraLabel": "sample string 9",
      "step": 10,
      "isTemplate": true
    },
    {
      "id": "sample string 1",
      "name": "sample string 2",
      "value": "sample string 7",
      "label": "sample string 8",
      "extraLabel": "sample string 9",
      "step": 10,
      "isTemplate": true
    }
  ],
  "type": {
    "id": "sample string 1",
    "platform": 2.1,
    "internalName": "sample string 3",
    "name": "sample string 4",
    "description": "sample string 5",
    "hidden": true,
    "settings": [
      {
        "id": "sample string 1",
        "name": "sample string 2",
        "value": "sample string 7",
        "label": "sample string 8",
        "extraLabel": "sample string 9",
        "step": 10,
        "isTemplate": true
      },
      {
        "id": "sample string 1",
        "name": "sample string 2",
        "value": "sample string 7",
        "label": "sample string 8",
        "extraLabel": "sample string 9",
        "step": 10,
        "isTemplate": true
      }
    ],
    "requiresVenue": true
  },
  "created": "2025-12-12T21:34:14.2267776-08:00",
  "updated": "2025-12-12T21:34:14.2267776-08:00",
  "status": {
    "id": "sample string 1",
    "internalName": "sample string 2",
    "name": "sample string 3"
  },
  "archived": false,
  "log": [
    {
      "status": "sample string 1",
      "date": "2025-12-12T21:34:14.2267776-08:00",
      "log": "sample string 3"
    },
    {
      "status": "sample string 1",
      "date": "2025-12-12T21:34:14.2267776-08:00",
      "log": "sample string 3"
    }
  ],
  "name": "sample string 3",
  "schedule": "2025-12-12T21:34:14.2267776-08:00",
  "favorite": true,
  "recurrent": true,
  "interval": 1
}