Get Metadata

Get Metadata

Retrieves all the metadata for the entity. User can view the entries if user can view the entity.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/entities/{id}/metadata
COPY
Path Parameters
string
id
Required

the URN of the entity the entry is attached to.

Query Parameters
string
filter
Optional

Filter for a query. FIQL format.

string
sortAsc
Optional

Field to use for ascending sort

string
sortDesc
Optional

Field to use for descending sort

integer
page
Required
Constraints: minimum: 1 default: 1

Page to fetch, zero offset.

integer
pageSize
Required
Constraints: minimum: 0 maximum: 128 default: 25

Results per page to fetch.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns MetadataEntries of type(s) application/json;version=39.1
This response body class contains all of the following: InlineMetadataEntries0 , InlineMetadataEntries1 
{
    "resultTotal": 0,
    "pageCount": 0,
    "page": 0,
    "pageSize": 0,
    "associations": [
        {
            "entityId": "string",
            "associationId": "string"
        }
    ],
    "values": [
        {
            "id": "string",
            "persistent": false,
            "readOnly": false,
            "keyValue": {
                "domain": "string",
                "namespace": "string",
                "key": "string",
                "value": {
                    "value": {},
                    "type": "string"
                }
            }
        }
    ]
}

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/entities/{id}/metadata?page=value&pageSize=v
Availability
Added in 37.0
On This Page
Defined Entity Operations
POST
Migrate Defined Entities Of Type
GET
Get Defined Entity
PUT
Update Defined Entity
DELETE
Delete Defined Entity
GET
Get Defined Entity Full Contents
POST
Resolve Defined Entity
GET
Get Metadata
POST
Create Metadata Entry
GET
Get Metadata Entry
PUT
Update Metadata Entry
DELETE
Delete Metadata Entry
GET
Get Metadata File Content
GET
Get Defined Entities By Entity Type Id
GET
Get Defined Entities By Entity Type
GET
Get Defined Entities By Entity Type No Version Specified
GET
Get Defined Entities By Interface
GET
Get Defined Entities By Interface Id