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.

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.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns MetadataEntries of type(s) application/json;version=38.1
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"
                }
            }
        }
    ]
}