Custom Metadata

PreviousSave Data

Last updated 8 months ago

Deletes a MetadataSpec

delete

Deletes a MetadataSpec with the specified id.

Authorizations

Path parameters

metadataSpecIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

delete

DELETE /api/rest/metadata_spec/{metadataSpecId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

GET /api/rest/metadata_spec/{metadataSpecName}/editor.json HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

GET /api/rest/metadata_spec/{metadataSpecName}/schema.json HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Gets a specific Metadata Spec

get

Gets a specific MetadataSpec by name or Id.

Authorizations

Path parameters

metadataSpecNameOrIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

GET /api/rest/metadata_spec/{metadataSpecNameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Get Metadata Specs

get

Gets a pagination of Metadata Specs for the given query.

Authorizations

Query parameters

offsetanyOptionalDefault: 0

countanyOptionalDefault: 20

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

GET /api/rest/metadata_spec HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Creates a new Metadata Spec definition

post

Creates a new Metadata Spec definition.

Authorizations

Body

Represents a request to create a MetadataSpec definition.

nameanyOptional

The name of the metadata spec.

typeundefined · enumOptional

The type of the metadata spec.

Possible values:

propertiesanyRequired

The token template tabs to create.

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

post

POST /api/rest/metadata_spec HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 305

{
  "name": null,
  "type": "STRING",
  "properties": [
    {
      "name": null,
      "displayName": null,
      "type": "STRING",
      "required": null,
      "placeholder": null,
      "defaultValue": null,
      "properties": [
        {
          "name": null,
          "displayName": null,
          "type": "STRING",
          "required": null,
          "placeholder": null,
          "defaultValue": null,
          "properties": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ]
}

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

Updates a Metadata Spec

put

Updates a MetadataSpec with the specified id.

Authorizations

Path parameters

metadataSpecIdanyRequired

Body

Represents a request to update a MetadataSpec.

nameanyOptional

The name of the metadata spec.

typeundefined · enumOptional

The type of the metadata spec.

Possible values:

propertiesanyOptional

The updated list of properties.

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

put

PUT /api/rest/metadata_spec/{metadataSpecId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 305

{
  "name": null,
  "type": "STRING",
  "properties": [
    {
      "name": null,
      "displayName": null,
      "type": "STRING",
      "required": null,
      "placeholder": null,
      "defaultValue": null,
      "properties": [
        {
          "name": null,
          "displayName": null,
          "type": "STRING",
          "required": null,
          "placeholder": null,
          "defaultValue": null,
          "properties": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ]
}

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