GBgbgplc

Retrieve task schema

Fetch the schema for a specific task to see the required fields and expected data structure. This schema defines the format of data required to complete the task.

post/journey/task/schema

Request

  • Base URL
    https://eu.platform.go.gbgplc.com/captain/api
  • Auth
    HTTP bearer

Request body

taskIdstring required

Unique identifier for the task assigned to the customer.

Example request

{
  "taskId": "TkoviRO58Q8R7qPnAkLAqBAT"
}

Response

Schema retrieved successfully.

$schemastring required

The JSON Schema version of the schema.

typestring required

The type of the schema.

propertiesobject required

An object containing the properties of the schema.

requiredstring[] required

An array of the required properties of the schema.

Changes

No recorded changes to this operation across all 1 revision of this API.