GET v1/jobs-queue/job-types?platform={platform}

Returns a list of job types, it will return job types for the platform specified.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
platform

Optional parameter for job platform. These will limit job types only to the platform sent. When null or a negative number is supplied the default value is 4.

 decimal number

None.

Body Parameters

None.

Response Information

Resource Description

Collection of QueueJobType
NameDescriptionTypeAdditional information
id

The system queue UUID

 string

None.
platform

Platform Version, this defaults to 2.1 as of platform 2.2

 decimal number

None.
internalName

Humanly readable Job Type

 string

None.
name

Contains the Display Names for this Job Type View

 string

None.
description

Contains the Display Description for this Job Type View

 string

None.
hidden

Specifies if this view item is supported by administrator utilities

 boolean

None.
settings

These are the default settings added to a job when creating a job/entity relationship.

 Collection of QueueJobSetting

None.
requiresVenue

boolean

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "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
  },
  {
    "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
  }
]