/metadata_spec

Previous/save_data Next/mock_session

Last updated 18 days ago

Deletes a MetadataSpec

delete

Deletes a MetadataSpec with the specified id.

Authorizations

Path parameters

metadataSpecIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/metadata_spec/{metadataSpecId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets a specific Metadata Editor Schema

get

Gets a specific Metadata Editor Schema backed by the supplied MetadataSpec by name.

Authorizations

Path parameters

metadataSpecNameanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/metadata_spec/{metadataSpecName}/editor.json' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets a specific JSON Schema

get

Gets a specific JSON Schema backed by the supplied MetadataSpec by name.

Authorizations

Path parameters

metadataSpecNameanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/metadata_spec/{metadataSpecName}/schema.json' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets a specific Metadata Spec

get

Gets a specific MetadataSpec by name or Id.

Authorizations

Path parameters

metadataSpecNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/metadata_spec/{metadataSpecNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Get Metadata Specs

get

Gets a pagination of Metadata Specs for the given query.

Authorizations

Query parameters

offsetany · default: 0optional

countany · default: 20optional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/metadata_spec' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Creates a new Metadata Spec definition

post

Creates a new Metadata Spec definition.

Authorizations

Body

nameanyoptional

The name of the metadata spec.

typeundefined · enumoptional

The type of the metadata spec.

Options: STRING, NUMBER, BOOLEAN, ARRAY, ENUM, OBJECT, TAGS

propertiesanyrequired

The token template tabs to create.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/metadata_spec' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "name": null,
    "type": "STRING",
    "properties": [
      {
        "name": null,
        "displayName": null,
        "type": "STRING",
        "required": null,
        "placeholder": null,
        "defaultValue": null,
        "properties": "[Circular Reference]"
      }
    ]
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Updates a Metadata Spec

put

Updates a MetadataSpec with the specified id.

Authorizations

Path parameters

metadataSpecIdanyrequired

Body

nameanyoptional

The name of the metadata spec.

typeundefined · enumoptional

The type of the metadata spec.

Options: STRING, NUMBER, BOOLEAN, ARRAY, ENUM, OBJECT, TAGS

propertiesanyoptional

The updated list of properties.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/metadata_spec/{metadataSpecId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "name": null,
    "type": "STRING",
    "properties": [
      {
        "name": null,
        "displayName": null,
        "type": "STRING",
        "required": null,
        "placeholder": null,
        "defaultValue": null,
        "properties": "[Circular Reference]"
      }
    ]
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}