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.
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
Page to fetch, zero offset.
integer
pageSize
Required
Results per page to fetch.
Responses
200
OK
Returns MetadataEntries of type(s) application/json;version=39.0
This response body class contains all of the following: Page , 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"
}
}
}
]
}
Availability
Added in 37.0
On This Page
Defined Entity Operations
POST
Create Metadata Entry
DELETE
Delete Defined Entity
DELETE
Delete Metadata Entry
GET
Get Defined Entities By Entity Type
GET
Get Defined Entities By Entity Type Id
GET
Get Defined Entities By Entity Type No Version Specified
GET
Get Defined Entities By Interface
GET
Get Defined Entities By Interface Id
GET
Get Defined Entity
GET
Get Defined Entity Full Contents
GET
Get Metadata
GET
Get Metadata Entry
GET
Get Metadata File Content
POST
Migrate Defined Entities Of Type
POST
Resolve Defined Entity
PUT
Update Defined Entity
PUT
Update Metadata Entry