Fetch Plugin Metadata

Plug-in metadata contains information about the types that this plug-in defines and their attributes or relations.

Request

URI

GET

https://{api_host}/vco/api/catalog/{namespace}/metadata

COPY

Path Parameters

string

namespace

Required

namespace

Query Parameters

boolean

showHiddenTypes

Optional

showHiddenTypes

Responses

200

The request is successful

Returns module-metadata of type(s) application/json

{
    "namespace": "string",
    "type": [
        {
            "attribute": [
                {
                    "description": "string",
                    "possible-result-type": "string",
                    "display-name": "string",
                    "name": "string"
                }
            ],
            "relation": [
                {
                    "display-name": "string",
                    "type": "string",
                    "name": "string"
                }
            ],
            "icon-href": "string",
            "name": "string"
        }
    ]
}

string

namespace

Optional

namespace

array of WsTypeMetadata

type

Optional

type

401

User is not authorized

Operation doesn't return any data structure

On This Page