Attributes get

api-version: 1.0

Retrieves a specific attribute.

Copy
Copied
GET /{collectionId}/{storageId}/_api/rest/facets/{facetId}/views/{viewId}/elements/{elementId}/attributes/{attributeId}

With optional parameters

Copy
Copied
GET /{collectionId}/{storageId}/_api/rest/facets/{facetId}/views/{viewId}/elements/{elementId}/attributes?$filter={filter}&$select={select}

Parameters

Name In Required Type Description
collectionId path true string The ID of the storage collection.
storageId path true string The ID of the tenant.
facetId path true string The name of the facet.
viewId path true string The name of the view.
elementId path true string The ID of the element.
attributeId path true string The name of the attribute.

Responses

Success 200

Name Type Description
count integer The number of returned values.
values Attribute The list of attributes.

Error 4xx

Name Type Description
message string The error message
output OperationResultOutput The result output.
type OperationResultType The result type.
data OperationError The list of errors.

Examples

Get the name attribute

Request

Copy
Copied
GET https://demo.symbioworld.com/pz/showcase/_api/rest/facets/processes/views/detail/elements/f4f3943d-6b3b-42a9-8a3a-30acf42ce7d5/attributes/name

Response (200 OK)

Copy
Copied
{
    "count": 1,
    "values": {
        "name": {
            "1031": "Ideen/Innovationen",
            "1033": "Idea/Innovation"
        }
    }
}

Definitions

OperationResultOutput

Name Type
volatile string
permanent string
dialog string
inline string

OperationResultType

Name Type
critical string
error string
warning string
success string
unauthorized string

OperationError

Name Type Description
error string The error message.