Organization
Users and User Groups
Permissions
Data Source
Workspaces
Logical Data Model
    Generate Logical Data Model
    LDM - Declarative APIs
    Datasets
    Attributes
      Get all AttributesgetGet an AttributegetPatch an Attribute (beta)patch
    Facts
    Labels
Analytical Objects
Reporting
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

Attributes (3.51)

Endpoint:/

Get all Attributes

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

Get all Attributes › path Parameters

  • workspaceIdstring · required

Get all Attributes › 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:
    datasets
    labels
    attributeHierarchies
    dataset
    defaultView
    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 Attributes › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get all Attributes › Responses

Request successfully processed

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

    Included resources

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

Get an Attribute

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

Get an Attribute › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Get an Attribute › 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:
    datasets
    labels
    attributeHierarchies
    dataset
    defaultView
    ALL
  • metaIncludestring[] · unique · style: form

    Include Meta objects.

    Included meta objects

    Enum values:
    origin
    all
    ALL

Get an Attribute › Headers

  • X-GDC-VALIDATE-RELATIONSboolean
    Default: false

Get an Attribute › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of attribute entity.

  • includedarray · unique

    Included resources

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

Patch an Attribute (beta)

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

Patch an Attribute (beta) › path Parameters

  • workspaceIdstring · required
  • objectIdstring · required

Patch an Attribute (beta) › 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:
    datasets
    labels
    attributeHierarchies
    dataset
    defaultView
    ALL

Patch an Attribute (beta) › Request Body

  • dataobject · required

    JSON:API representation of patching attribute entity.

Patch an Attribute (beta) › Responses

Request successfully processed

  • dataobject · required

    JSON:API representation of attribute entity.

  • includedarray · unique

    Included resources

  • linksobject
PATCH /api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}
DatasetsFacts