Skip to content
Cloud APIs
/
/
/Schemas

Schemas

Schema management

Operations

Get schema
deprecated

Request

The API returns the schema specified by the given kind, which must follow the naming convention {data-partition-id}:{dataset}:{type}:{version}. Required roles: 'users.datalake.viewers' or 'users.datalake.editors' or 'users.datalake.admins'

Security
bearer
Path
kindstringrequired

Kind

Headers
data-partition-idstringrequired

desired data partition id

curl -i -X GET \
  'https://as5.api.enterprisedata.slb.com/api/storage/v2/schemas/{kind}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'data-partition-id: string'

Responses

Schema obtained successfully.

Bodyapplication/json
kindstringrequired

Record kind for which the schema information is applied to.

Example:"slb-osdu-prod-des-prod-testing:wks:work-product-component--WellLog:1.0.0"
schemaArray of objects(SchemaItem)required

List of schema items which compose the schema.

Example:
[
  {
    "path": "msg",
    "kind": "string",
    "ext": {}
  },
  {
    "path": "year",
    "kind": "int",
    "ext": {}
  },
  {
    "path": "weight",
    "kind": "float",
    "ext": {}
  },
  {
    "path": "location",
    "kind": "core:dl:geopoint:1.0.0",
    "ext": {}
  },
  {
    "path": "valid",
    "kind": "bool",
    "ext": {}
  }
]
extobject

Extension field for custom schema definition.

Response
{
  "kind": "slb-osdu-prod-des-prod-testing:wks:work-product-component--WellLog:1.0.0",
  "schema": [
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}