Get the setup for a JobAgentType.

GET 
/:customerId/job-agents/types/:jobAgentTypeId

Get the setup for a JobAgentType.

Request

Path Parameters

customerId uuidrequired

A unique UUID value that identifies the customer.

jobAgentTypeId stringrequired

JobAgentTypeId of the JobAgentType to get.

Header Parameters

X-MindKey-User-Language string

Default value: en-us

Specify User UI Language

X-MindKey-User-Culture string

Default value: en-us

Specify User UI Culture

X-MindKey-User-Timezone string

Default value: Europe/Copenhagen

Specify timezone.

Responses

200

OK

application/json

Schema

Schema

• Array [

repeatEmail boolean
showCulture boolean
showKeywords boolean
allowSaveDisclaimer stringnullable

cultures

object[]

nullable

Array [

cultureId stringnullable

name stringnullable

]

locations

object[]

nullable

Array [

id stringnullable

description stringnullable

]

fieldsOfWork

object[]

nullable

Array [

id stringnullable

description stringnullable

]

regions

object[]

nullable

Array [

id stringnullable

description stringnullable

]

• ]

Example (from schema)

[
  {
    "repeatEmail": true,
    "showCulture": true,
    "showKeywords": true,
    "allowSaveDisclaimer": "string",
    "cultures": [
      {
        "cultureId": "string",
        "name": "string"
      }
    ],
    "locations": [
      {
        "id": "string",
        "description": "string"
      }
    ],
    "fieldsOfWork": [
      {
        "id": "string",
        "description": "string"
      }
    ],
    "regions": [
      {
        "id": "string",
        "description": "string"
      }
    ]
  }
]

400

Bad request provided

404

Not Found

500

Internal Server Error

Loading...