Metadata APIs

Archive Metadata Node

OVERVIEW



Overview

Archive a metadata node within Publisher

This API call is used to archive a metadata node within the system. The metadata node identifier is the id or name of the metadata node.

Since v5.1

HTTP Request

POST  /api/2/metadata/<ID>/archive

OR

POST  /api/2/metadata/<NAME>/archive

 

URL Parameters
Parameter Description
ID The ID of the metadata node to archive
NAME The name of the metadata node to archive

 

HTTP Request Object

No data is passed in the HTTP Request

HTTP Headers
HTTP Request Header Description Example
Authorization The API Authorisation token. "Bearer XXXXXXXXXXXXX"
Accept

The format of the expected response. 

  • "application/json"
  • "application/xml"

If no parameter is set, JSON is the default response given.

 "application/xml"
 

 

  

 

HTTP Response

Success

HTTP response 200 with Metadata summary Object 

(Example below)

 

Error

See API Error messages 

Example HTTP Request & Response

POST http://example.com/context/api/2/metadata/3/archive

 

JSON Response

{

    "metadata": {

            "id": 3,

            "name": "Risk rating",

            "link": "http://example.com/context/api/2/metadata/3"

    }

}

 

 

Comments


0 Comments

Last Updated: Jun 09,2023