Skip to content
Cloud APIs
/
FDPlan
/
/Schemas

Schemas

Getting schema for data-types.

Operations

Get schema

Request

Get a schema given its schema ID.

Security
bearer and appkey
Path
schemaIdstringrequired

The ID of the schema.

Headers
slb-partition-idstringrequired

Data partition id.

curl -i -X GET \
  'https://api.delfi.slb.com/fdplan/evaluation/v1/schemas/{schemaId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'appkey: YOUR_API_KEY_HERE' \
  -H 'slb-partition-id: string'

Responses

Retrieved schema successfully.

Bodyapplication/json
idstringrequired

The unique idenitifer for the schema.

Example:"planning:fdplan:result-set:0.0.1"
typestringrequired

The type of schema, for instance JSON schema.

Value:"JSON"
Example:"JSON"
definitionobjectrequired

The schema definition.

Example:
{}
Response
{
  "id": "planning:fdplan:result-set:0.0.1",
  "type": "JSON",
  "definition": {}
}