Skip to content

Spec

idstringrequired

The ID of the specification.

Example:"01DV2RPKYS5NYBAR6TNMJ8TNT8"
namestringrequired

The name of the specification.

Example:"A custom data-type"
versionintegerrequired

The version of the specification definition.

Example:1
latestbooleanrequired

Whether this is the latest version of the given specification.

Example:true
archivedbooleanrequired

Whether this specification has been marked as archived.

Example:false
descriptionstringrequired

The description of the specification.

Example:"A specification"
createdBystringrequired

The ID of the user who created the specification.

Example:"user@slb.com"
createdAtstring, (date-time)required

The date the specification was created.

Example:"2020-01-01T00:00:00.000Z"
{ "id": "01DV2RPKYS5NYBAR6TNMJ8TNT8", "name": "spec-type", "version": 1, "latest": true, "archived": false, "description": "A specification.", "createdBy": "user@slb.com", "createdAt": "2020-01-01T00:00:00.000Z" }