Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
Analytical Objects
    Analytics Model
    Metrics
    Dashboards
    Context Filters
    Filter Views
    Visualization Object
    Dependency Graph
    Attribute Hierarchies
      Get all Attribute HierarchiesgetPost Attribute HierarchiespostGet an Attribute HierarchygetPut an Attribute HierarchyputDelete an Attribute HierarchydeletePatch an Attribute Hierarchypatch
Reporting
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

Attribute Hierarchies (3.51)

Endpoint:/

Get all Attribute Hierarchies

GET
/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies

Get all Attribute Hierarchies › path Parameters

  • workspaceIdstring · required

Get all Attribute Hierarchies › query Parameters

  • originstring · enum

    Defines scope of origin of objects. All by default.

    Enum values:
    ALL
    PARENTS
    NATIVE
    Default: ALL
  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

  • includestring[] · style: form

    Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

    WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.

    Enum values:
    userIdentifiers
    attributes
    createdBy
    modifiedBy
    ALL
  • pageinteger

    Zero-based page index (0..N)

    Default: 0
  • sizeinteger

    The size of the page to be returned

    Default: 20
  • sortstring[]

    Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    page
    all
    ALL

Get all Attribute Hierarchies › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get all Attribute Hierarchies › Responses

Request successfully processed

  • dataobject[] · unique · required
  • includedarray · unique

    Included resources

  • linksobject
  • metaobject
GET /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies

Post Attribute Hierarchies

POST
/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies

Post Attribute Hierarchies › path Parameters

  • workspaceIdstring · required

Post Attribute Hierarchies › query Parameters

  • includestring[] · style: form

    Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

    WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.

    Enum values:
    userIdentifiers
    attributes
    createdBy
    modifiedBy
    ALL
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Post Attribute Hierarchies › Request Body

  • dataobject · required

    JSON:API representation of attributeHierarchy entity.

Post Attribute Hierarchies › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of attributeHierarchy entity.

  • includedarray · unique

    Included resources

  • linksobject
POST /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies

Get an Attribute Hierarchy

GET
/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}

Get an Attribute Hierarchy › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Get an Attribute Hierarchy › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

  • includestring[] · style: form

    Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

    WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.

    Enum values:
    userIdentifiers
    attributes
    createdBy
    modifiedBy
    ALL
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Get an Attribute Hierarchy › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get an Attribute Hierarchy › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of attributeHierarchy entity.

  • includedarray · unique

    Included resources

  • linksobject
GET /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}

Put an Attribute Hierarchy

PUT
/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}

Put an Attribute Hierarchy › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Put an Attribute Hierarchy › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

  • includestring[] · style: form

    Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

    WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.

    Enum values:
    userIdentifiers
    attributes
    createdBy
    modifiedBy
    ALL

Put an Attribute Hierarchy › Request Body

  • dataobject · required

    JSON:API representation of attributeHierarchy entity.

Put an Attribute Hierarchy › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of attributeHierarchy entity.

  • includedarray · unique

    Included resources

  • linksobject
PUT /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}

Delete an Attribute Hierarchy

DELETE
/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}

Delete an Attribute Hierarchy › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Delete an Attribute Hierarchy › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

Delete an Attribute Hierarchy › Responses

Successfully deleted

No data returned
DELETE /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}

Patch an Attribute Hierarchy

PATCH
/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}

Patch an Attribute Hierarchy › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Patch an Attribute Hierarchy › query Parameters

  • filterstring

    Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123').

  • includestring[] · style: form

    Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter "ALL" is present, all possible includes are used (include=ALL).

    WARNING: Individual include types (collection, relationship or ALL) cannot be combined together.

    Enum values:
    userIdentifiers
    attributes
    createdBy
    modifiedBy
    ALL

Patch an Attribute Hierarchy › Request Body

  • dataobject · required

    JSON:API representation of patching attributeHierarchy entity.

Patch an Attribute Hierarchy › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of attributeHierarchy entity.

  • includedarray · unique

    Included resources

  • linksobject
PATCH /api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}
Dependency GraphUsage