Custom Metadata

Get Metadata Specs

Gets a pagination of Metadata Specs for the given query.

GEThttp://localhost:8080/api/rest/metadata_spec

Query parameters

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/metadata_spec', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

400401403404409500501503default

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

Creates a new Metadata Spec definition

Creates a new Metadata Spec definition.

POSThttp://localhost:8080/api/rest/metadata_spec

Body

*/*

nameany

The name of the metadata spec.

typeenum

The type of the metadata spec.

STRINGNUMBERBOOLEANARRAYENUMOBJECTTAGS

properties*any

The token template tabs to create.

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/metadata_spec', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401403404409500501503default

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

Updates a Metadata Spec

Updates a MetadataSpec with the specified id.

PUThttp://localhost:8080/api/rest/metadata_spec/{metadataSpecId}

Path parameters

metadataSpecId*any

Body

*/*

nameany

The name of the metadata spec.

typeenum

The type of the metadata spec.

STRINGNUMBERBOOLEANARRAYENUMOBJECTTAGS

propertiesany

The updated list of properties.

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/metadata_spec/{metadataSpecId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401403404409500501503default

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

Deletes a MetadataSpec

Deletes a MetadataSpec with the specified id.

DELETEhttp://localhost:8080/api/rest/metadata_spec/{metadataSpecId}

Path parameters

metadataSpecId*any

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/metadata_spec/{metadataSpecId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409500501503

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

Gets a specific Metadata Editor Schema

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

GEThttp://localhost:8080/api/rest/metadata_spec/{metadataSpecName}/editor.json

Path parameters

metadataSpecName*any

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/metadata_spec/{metadataSpecName}/editor.json', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

400401403404409500501503default

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

Gets a specific JSON Schema

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

GEThttp://localhost:8080/api/rest/metadata_spec/{metadataSpecName}/schema.json

Path parameters

metadataSpecName*any

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/metadata_spec/{metadataSpecName}/schema.json', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

400401403404409500501503default

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

Gets a specific Metadata Spec

Gets a specific MetadataSpec by name or Id.

GEThttp://localhost:8080/api/rest/metadata_spec/{metadataSpecNameOrId}

Path parameters

metadataSpecNameOrId*any

Response

400401403404409500501503default

Body

application/json

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

JavaScriptCurlPython

const response = await fetch('http://localhost:8080/api/rest/metadata_spec/{metadataSpecNameOrId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

400401403404409500501503default

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