Custom Metadata

PreviousSave Data

Get Metadata Specs

Gets a pagination of Metadata Specs for the given query.

get

/metadata_spec

Authorizations

Query parameters

offsetany · default: 0

countany · default: 20

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

Creates a new Metadata Spec definition.

post

/metadata_spec

Authorizations

Body

nameany

The name of the metadata spec.

typeundefined · enum

The type of the metadata spec.

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

propertiesanyrequired

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,
        "required": null,
        "placeholder": null,
        "defaultValue": null,
        "type": "STRING",
        "properties": "[Circular Reference]"
      }
    ]
  }'

400

401

403

404

409

500

501

503

default

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

Updates a Metadata Spec

Updates a MetadataSpec with the specified id.

put

/metadata_spec/{metadataSpecId}

Authorizations

Path parameters

metadataSpecIdanyrequired

Body

nameany

The name of the metadata spec.

typeundefined · enum

The type of the metadata spec.

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

propertiesany

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,
        "required": null,
        "placeholder": null,
        "defaultValue": null,
        "type": "STRING",
        "properties": "[Circular Reference]"
      }
    ]
  }'

400

401

403

404

409

500

501

503

default

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

Deletes a MetadataSpec

Deletes a MetadataSpec with the specified id.

delete

/metadata_spec/{metadataSpecId}

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

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

get

/metadata_spec/{metadataSpecName}/editor.json

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

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

get

/metadata_spec/{metadataSpecName}/schema.json

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

Gets a specific MetadataSpec by name or Id.

get

/metadata_spec/{metadataSpecNameOrId}

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"
}