Documentation Powered by ReDoc

OpenAPI definition (3.29)

Download OpenAPI specification:Download

Cookie Security Configuration

Get CookieSecurityConfiguration

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=lastRotation==InstantValue;rotationInterval==DurationValue

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').

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Patch CookieSecurityConfiguration

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=lastRotation==InstantValue;rotationInterval==DurationValue

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').

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiCookieSecurityConfigurationPatch)

JSON:API representation of patching cookieSecurityConfiguration entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Put CookieSecurityConfiguration

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=lastRotation==InstantValue;rotationInterval==DurationValue

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').

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiCookieSecurityConfigurationIn)

JSON:API representation of cookieSecurityConfiguration entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Organization - Declarative APIs

Get organization layout

Retrieve complete layout of organization, workspaces, user-groups, etc.

query Parameters
exclude
Array of strings
Items Value: "ACTIVITY_INFO"

Responses

Response samples

Content type
application/json
{
  • "dataSources": [
    ],
  • "identityProviders": [
    ],
  • "jwks": [
    ],
  • "notificationChannels": [
    ],
  • "organization": {
    },
  • "userGroups": [
    ],
  • "users": [
    ],
  • "workspaceDataFilters": [
    ],
  • "workspaces": [
    ]
}

Set organization layout

Sets complete layout of organization, like workspaces, user-groups, etc.

Request Body schema: application/json
Array of objects (DeclarativeDataSource) [ items ]
Array of objects (DeclarativeIdentityProvider) [ items ]
Array of objects (DeclarativeJwk) [ items ]
Array of objects (DeclarativeNotificationChannel) [ items ]
required
object (DeclarativeOrganizationInfo)

Information available about an organization.

Array of objects (DeclarativeUserGroup) [ items ]
Array of objects (DeclarativeUser) [ items ]
Array of objects (DeclarativeWorkspaceDataFilter) [ items ]
Array of objects (DeclarativeWorkspace) [ items ]

Responses

Request samples

Content type
application/json
{
  • "dataSources": [
    ],
  • "identityProviders": [
    ],
  • "jwks": [
    ],
  • "notificationChannels": [
    ],
  • "organization": {
    },
  • "userGroups": [
    ],
  • "users": [
    ],
  • "workspaceDataFilters": [
    ],
  • "workspaces": [
    ]
}

Organization - Entity APIs

Get Organizations

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321

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').

include
Array of strings
Items Enum: "users" "userGroups" "bootstrapUser" "bootstrapUserGroup" "ALL"
Example: include=include=bootstrapUser,bootstrapUserGroup

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.

metaInclude
Array of strings unique
Items Enum: "permissions" "all" "ALL"
Example: metaInclude=metaInclude=permissions,all

Include Meta objects.

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Patch Organization

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321

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').

include
Array of strings
Items Enum: "users" "userGroups" "bootstrapUser" "bootstrapUserGroup" "ALL"
Example: include=include=bootstrapUser,bootstrapUserGroup

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiOrganizationPatch)

JSON:API representation of patching organization entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Put Organization

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321

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').

include
Array of strings
Items Enum: "users" "userGroups" "bootstrapUser" "bootstrapUserGroup" "ALL"
Example: include=include=bootstrapUser,bootstrapUserGroup

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiOrganizationIn)

JSON:API representation of organization entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Get current organization info

Gets a basic information about organization.

query Parameters
metaInclude
Array of strings unique
Items Enum: "permissions" "all"
Example: metaInclude=metaInclude=permissions

Return list of permissions available to logged user.

Responses

Get Organization entities

query Parameters
filter
string
Example: filter=filter=content==JsonNodeValue;type==SettingTypeValue

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').

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "page" "all" "ALL"
Example: metaInclude=metaInclude=page,all

Include Meta objects.

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post Organization Setting entities

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiOrganizationSettingIn)

JSON:API representation of organizationSetting entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Delete Organization entity

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=content==JsonNodeValue;type==SettingTypeValue

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').

Responses

Get Organization entity

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=content==JsonNodeValue;type==SettingTypeValue

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').

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Patch Organization entity

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=content==JsonNodeValue;type==SettingTypeValue

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').

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiOrganizationSettingPatch)

JSON:API representation of patching organizationSetting entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Put Organization entity

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=content==JsonNodeValue;type==SettingTypeValue

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').

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiOrganizationSettingIn)

JSON:API representation of organizationSetting entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Options

Links for all configuration options

Retrieves links for all options for different configurations.

Responses

Response samples

Content type
application/json

All options

{
  • "options": {
    }
}

CSP Directives

Get CSP Directives

Context Security Police Directive

query Parameters
filter
string
Example: filter=filter=sources==v1,v2,v3

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').

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "page" "all" "ALL"
Example: metaInclude=metaInclude=page,all

Include Meta objects.

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post CSP Directives

Context Security Police Directive

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiCspDirectiveIn)

JSON:API representation of cspDirective entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Delete CSP Directives

Context Security Police Directive

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=sources==v1,v2,v3

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').

Responses

Get CSP Directives

Context Security Police Directive

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=sources==v1,v2,v3

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').

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Patch CSP Directives

Context Security Police Directive

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=sources==v1,v2,v3

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').

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiCspDirectivePatch)

JSON:API representation of patching cspDirective entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Put CSP Directives

Context Security Police Directive

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=sources==v1,v2,v3

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').

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiCspDirectiveIn)

JSON:API representation of cspDirective entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

JWKS

Get all Jwks

Returns all JSON web keys - used to verify JSON web tokens (Jwts)

query Parameters
filter
string
Example: filter=filter=content==JwkSpecificationValue

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').

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "page" "all" "ALL"
Example: metaInclude=metaInclude=page,all

Include Meta objects.

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post Jwks

Creates JSON web key - used to verify JSON web tokens (Jwts)

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiJwkIn)

JSON:API representation of jwk entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Delete Jwk

Deletes JSON web key - used to verify JSON web tokens (Jwts)

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=content==JwkSpecificationValue

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').

Responses

Get Jwk

Returns JSON web key - used to verify JSON web tokens (Jwts)

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=content==JwkSpecificationValue

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').

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Patch Jwk

Patches JSON web key - used to verify JSON web tokens (Jwts)

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=content==JwkSpecificationValue

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').

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiJwkPatch)

JSON:API representation of patching jwk entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Put Jwk

Updates JSON web key - used to verify JSON web tokens (Jwts)

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=content==JwkSpecificationValue

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').

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiJwkIn)

JSON:API representation of jwk entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Notification Channels

Test notification channel.

Tests the notification channel by sending a test notification.

Request Body schema: application/json
required
DefaultSmtp (object) or InPlatform (object) or Smtp (object) or Webhook (object)

Responses

Request samples

Content type
application/json
{
  • "destination": {
    }
}

Response samples

Content type
application/json
Example
An example of a successful connection
An example of a successful connection
An example of an unsuccessful connection

An example of a successful connection

{
  • "successful": true
}

Test existing notification channel.

Tests the existing notification channel by sending a test notification.

path Parameters
notificationChannelId
required
string
Request Body schema: application/json
required
DefaultSmtp (object) or InPlatform (object) or Smtp (object) or Webhook (object)

Responses

Request samples

Content type
application/json
{
  • "destination": {
    }
}

Response samples

Content type
application/json
Example
An example of a successful connection
An example of a successful connection
An example of an unsuccessful connection

An example of a successful connection

{
  • "successful": true
}

Get latest notifications.

Get latest in-platform notifications for the current user.

query Parameters
workspaceId
string

Workspace ID to filter notifications by.

isRead
boolean

Filter notifications by read status.

page
string >= 0
Default: "0"

Zero-based page index (0..N)

size
string >= 1
Default: "20"

The size of the page to be returned.

metaInclude
Array of strings unique
Items Enum: "total" "ALL"

Additional meta information to include in the response.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get all Notification Channel entities

query Parameters
filter
string
Example: filter=filter=name==someString;description==someString

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').

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "page" "all" "ALL"
Example: metaInclude=metaInclude=page,all

Include Meta objects.

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post Notification Channel entities

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiNotificationChannelPostOptionalId)

JSON:API representation of notificationChannel entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Delete Notification Channel entity

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString;description==someString

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').

Responses

Get Notification Channel entity

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString;description==someString

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').

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Patch Notification Channel entity

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString;description==someString

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').

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiNotificationChannelPatch)

JSON:API representation of patching notificationChannel entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Put Notification Channel entity

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString;description==someString

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').

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiNotificationChannelIn)

JSON:API representation of notificationChannel entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Get all notification channels layout

Gets complete layout of notification channels.

Responses

Response samples

Content type
application/json
{
  • "notificationChannels": [
    ]
}

Set all notification channels

Sets notification channels in organization.

Request Body schema: application/json
required
Array of objects (DeclarativeNotificationChannel) [ items ]

Responses

Request samples

Content type
application/json
{
  • "notificationChannels": [
    ]
}

Identity Providers

Get all Identity Providers

query Parameters
filter
string
Example: filter=filter=identifiers==v1,v2,v3;customClaimMapping==MapValue

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').

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "page" "all" "ALL"
Example: metaInclude=metaInclude=page,all

Include Meta objects.

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post Identity Providers

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiIdentityProviderIn)

JSON:API representation of identityProvider entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Delete Identity Provider

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=identifiers==v1,v2,v3;customClaimMapping==MapValue

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').

Responses

Get Identity Provider

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=identifiers==v1,v2,v3;customClaimMapping==MapValue

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').

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Patch Identity Provider

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=identifiers==v1,v2,v3;customClaimMapping==MapValue

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').

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiIdentityProviderPatch)

JSON:API representation of patching identityProvider entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Put Identity Provider

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=identifiers==v1,v2,v3;customClaimMapping==MapValue

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').

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiIdentityProviderIn)

JSON:API representation of identityProvider entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Get all identity providers layout

Gets complete layout of identity providers.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set all identity providers

Sets identity providers in organization.

Request Body schema: application/json
Array
object <= 10000 characters

Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name, urn.gooddata.user_groups [optional]). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.

id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$

FilterView object ID.

identifiers
required
Array of strings

List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP. In multiple provider setup, this field is mandatory.

oauthClientId
string <= 255 characters

The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.

oauthClientSecret
string <= 255 characters

The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.

oauthIssuerLocation
string <= 255 characters

The location of your OIDC provider. This field is mandatory for OIDC IdP.

samlMetadata
string <= 15000 characters

Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer's name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

API tokens

List all api tokens for a user

path Parameters
userId
required
string
query Parameters
filter
string
Example: filter=filter=bearerToken==someString

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').

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "page" "all" "ALL"
Example: metaInclude=metaInclude=page,all

Include Meta objects.

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{}

Post a new API token for the user

path Parameters
userId
required
string
Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiApiTokenIn)

JSON:API representation of apiToken entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Delete an API Token for a user

path Parameters
userId
required
string
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=bearerToken==someString

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').

Responses

Get an API Token for a user

path Parameters
userId
required
string
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=bearerToken==someString

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').

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Users - Entity APIs

Get User entities

User - represents entity interacting with platform

query Parameters
filter
string
Example: filter=filter=authenticationId==someString;firstname==someString

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').

include
Array of strings
Items Enum: "userGroups" "ALL"
Example: include=include=userGroups

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.

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "page" "all" "ALL"
Example: metaInclude=metaInclude=page,all

Include Meta objects.

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "included": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post User entities

User - represents entity interacting with platform

query Parameters
include
Array of strings
Items Enum: "userGroups" "ALL"
Example: include=include=userGroups

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiUserIn)

JSON:API representation of user entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Delete User entity

User - represents entity interacting with platform

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=authenticationId==someString;firstname==someString

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').

Responses

Get User entity

User - represents entity interacting with platform

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=authenticationId==someString;firstname==someString

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').

include
Array of strings
Items Enum: "userGroups" "ALL"
Example: include=include=userGroups

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.

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Patch User entity

User - represents entity interacting with platform

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=authenticationId==someString;firstname==someString

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').

include
Array of strings
Items Enum: "userGroups" "ALL"
Example: include=include=userGroups

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiUserPatch)

JSON:API representation of patching user entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Put User entity

User - represents entity interacting with platform

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=authenticationId==someString;firstname==someString

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').

include
Array of strings
Items Enum: "userGroups" "ALL"
Example: include=include=userGroups

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiUserIn)

JSON:API representation of user entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Users - Declarative APIs

Get all users

Retrieve all users including authentication properties.

Responses

Response samples

Content type
application/json
{
  • "users": [
    ]
}

Put all users

Set all users and their authentication properties.

Request Body schema: application/json
required
Array of objects (DeclarativeUser) [ items ]

Responses

Request samples

Content type
application/json
{
  • "users": [
    ]
}

UserGroups - Entity APIs

Get UserGroup entities

User Group - creates tree-like structure for categorizing users

query Parameters
filter
string
Example: filter=filter=name==someString

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').

include
Array of strings
Items Enum: "userGroups" "parents" "ALL"
Example: include=include=parents

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.

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "page" "all" "ALL"
Example: metaInclude=metaInclude=page,all

Include Meta objects.

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "included": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post User Group entities

User Group - creates tree-like structure for categorizing users

query Parameters
include
Array of strings
Items Enum: "userGroups" "parents" "ALL"
Example: include=include=parents

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiUserGroupIn)

JSON:API representation of userGroup entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Delete UserGroup entity

User Group - creates tree-like structure for categorizing users

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString

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').

Responses

Get UserGroup entity

User Group - creates tree-like structure for categorizing users

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString

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').

include
Array of strings
Items Enum: "userGroups" "parents" "ALL"
Example: include=include=parents

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.

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Patch UserGroup entity

User Group - creates tree-like structure for categorizing users

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString

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').

include
Array of strings
Items Enum: "userGroups" "parents" "ALL"
Example: include=include=parents

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiUserGroupPatch)

JSON:API representation of patching userGroup entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Put UserGroup entity

User Group - creates tree-like structure for categorizing users

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString

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').

include
Array of strings
Items Enum: "userGroups" "parents" "ALL"
Example: include=include=parents

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiUserGroupIn)

JSON:API representation of userGroup entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

UserGroups - Declarative APIs

Get all user groups

Retrieve all user-groups eventually with parent group.

Responses

Response samples

Content type
application/json
{
  • "userGroups": [
    ]
}

Put all user groups

Define all user groups with their parents eventually.

Request Body schema: application/json
required
Array of objects (DeclarativeUserGroup) [ items ]

Responses

Request samples

Content type
application/json
{
  • "userGroups": [
    ]
}

Get all users and user groups

Retrieve all users and user groups with theirs properties.

Responses

Response samples

Content type
application/json
{
  • "userGroups": [
    ],
  • "users": [
    ]
}

Put all users and user groups

Define all users and user groups with theirs properties.

Request Body schema: application/json
required
Array of objects (DeclarativeUserGroup) [ items ]
required
Array of objects (DeclarativeUser) [ items ]

Responses

Request samples

Content type
application/json
{
  • "userGroups": [
    ],
  • "users": [
    ]
}

User Authorization

Invite User

Puts a new invitation requirement into the invitation generator queue. This is a GoodData Cloud specific endpoint.

Request Body schema: application/json
email
required
string <email>
firstName
string
lastName
string
userId
string

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "userId": "string"
}

Get all users

Get all users - dedicated endpoint for user management in the internal OIDC provider. GoodData.CN specific

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a user

Create a user - dedicated endpoint for user management in the internal OIDC provider. GoodData.CN specific

Request Body schema: application/json
authenticationId
string

Field, which should be stored in metadata in authenticationId field. In PUT and POST method it must be not present, or equal to value calculated by backend (e.g. returned from previous GET).

displayName
required
string

User description, which will be visible in application.

email
required
string

Email - used as lookup (must be unique). For PUT method, it must be same as in URL

password
string

User password. It is not returned by GET method.

Responses

Request samples

Content type
application/json
{
  • "authenticationId": "string",
  • "displayName": "jeremy",
  • "email": "zeus@example.com",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "authenticationId": "string",
  • "displayName": "jeremy",
  • "email": "zeus@example.com",
  • "password": "string"
}

Delete a user

Delete a user - dedicated endpoint for user management in the internal OIDC provider. GoodData.CN specific

path Parameters
userEmail
required
string

Responses

Get a user

Get a user - dedicated endpoint for user management in the internal OIDC provider. GoodData.CN specific

path Parameters
userEmail
required
string

Responses

Response samples

Content type
application/json
{
  • "authenticationId": "string",
  • "displayName": "jeremy",
  • "email": "zeus@example.com",
  • "password": "string"
}

Update a user

Update a user - dedicated endpoint for user management in the internal OIDC provider. GoodData.CN specific

path Parameters
userEmail
required
string
Request Body schema: application/json
authenticationId
string

Field, which should be stored in metadata in authenticationId field. In PUT and POST method it must be not present, or equal to value calculated by backend (e.g. returned from previous GET).

displayName
required
string

User description, which will be visible in application.

email
required
string

Email - used as lookup (must be unique). For PUT method, it must be same as in URL

password
string

User password. It is not returned by GET method.

Responses

Request samples

Content type
application/json
{
  • "authenticationId": "string",
  • "displayName": "jeremy",
  • "email": "zeus@example.com",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "authenticationId": "string",
  • "displayName": "jeremy",
  • "email": "zeus@example.com",
  • "password": "string"
}

Get Profile

Returns a Profile including Organization and Current User Information.

Responses

Response samples

Content type
application/json
{
  • "entitlements": [
    ],
  • "features": {
    },
  • "links": {
    },
  • "name": "string",
  • "organizationId": "string",
  • "organizationName": "string",
  • "permissions": [
    ],
  • "telemetry": {
    },
  • "telemetryConfig": {
    },
  • "userId": "string"
}

User Settings

List all settings for a user

path Parameters
userId
required
string
query Parameters
filter
string
Example: filter=filter=content==JsonNodeValue;type==SettingTypeValue

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').

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "page" "all" "ALL"
Example: metaInclude=metaInclude=page,all

Include Meta objects.

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post new user settings for the user

path Parameters
userId
required
string
Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiUserSettingIn)

JSON:API representation of userSetting entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Delete a setting for a user

path Parameters
userId
required
string
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=content==JsonNodeValue;type==SettingTypeValue

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').

Responses

Get a setting for a user

path Parameters
userId
required
string
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=content==JsonNodeValue;type==SettingTypeValue

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').

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Put new user settings for the user

path Parameters
userId
required
string
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=content==JsonNodeValue;type==SettingTypeValue

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').

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiUserSettingIn)

JSON:API representation of userSetting entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

User Identifiers

Get UserIdentifier entities

UserIdentifier - represents entity interacting with platform

query Parameters
filter
string
Example: filter=filter=firstname==someString;lastname==someString

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').

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "page" "all" "ALL"
Example: metaInclude=metaInclude=page,all

Include Meta objects.

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get UserIdentifier entity

UserIdentifier - represents basic information about entity interacting with platform

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=firstname==someString;lastname==someString

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').

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

User management

Use case APIs for user management

assignPermissions

Request Body schema: application/json
required
Array of objects (AssigneeIdentifier) [ items ]
Array of objects (UserManagementDataSourcePermissionAssignment) [ items ]
Array of objects (UserManagementWorkspacePermissionAssignment) [ items ]

Responses

Request samples

Content type
application/json
{
  • "assignees": [
    ],
  • "dataSources": [
    ],
  • "workspaces": [
    ]
}

removeUsersUserGroups

Request Body schema: application/json
Array
id
required
string
type
required
string
Enum: "user" "userGroup"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

revokePermissions

Request Body schema: application/json
required
Array of objects (AssigneeIdentifier) [ items ]
Array of objects (UserManagementDataSourcePermissionAssignment) [ items ]
Array of objects (UserManagementWorkspacePermissionAssignment) [ items ]

Responses

Request samples

Content type
application/json
{
  • "assignees": [
    ],
  • "dataSources": [
    ],
  • "workspaces": [
    ]
}

listUserGroups

query Parameters
page
integer <int32>
Default: 0
Example: page=page=0

Zero-based page index (0..N)

size
integer <int32>
Default: 20
Example: size=size=20

The size of the page to be returned.

name
string
Example: name=name=charles

Filter by user name. Note that user name is case insensitive.

workspace
string
Example: workspace=workspace=demo

Filter by workspaceId.

dataSource
string
Example: dataSource=dataSource=demo-test-ds

Filter by dataSourceId.

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "userGroups": [
    ]
}

addGroupMembers

path Parameters
userGroupId
required
string
Request Body schema: application/json
required
Array of objects (UserManagementUserGroupMember) [ items ]

Responses

Request samples

Content type
application/json
{
  • "members": [
    ]
}

getGroupMembers

path Parameters
userGroupId
required
string

Responses

Response samples

Content type
application/json
{
  • "members": [
    ]
}

listPermissionsForUserGroup

path Parameters
userGroupId
required
string

Responses

Response samples

Content type
application/json
{
  • "dataSources": [
    ],
  • "workspaces": [
    ]
}

managePermissionsForUserGroup

path Parameters
userGroupId
required
string
Request Body schema: application/json
required
Array of objects (UserManagementDataSourcePermissionAssignment) [ items ]
required
Array of objects (UserManagementWorkspacePermissionAssignment) [ items ]

Responses

Request samples

Content type
application/json
{
  • "dataSources": [
    ],
  • "workspaces": [
    ]
}

removeGroupMembers

path Parameters
userGroupId
required
string
Request Body schema: application/json
required
Array of objects (UserManagementUserGroupMember) [ items ]

Responses

Request samples

Content type
application/json
{
  • "members": [
    ]
}

listUsers

query Parameters
page
integer <int32>
Default: 0
Example: page=page=0

Zero-based page index (0..N)

size
integer <int32>
Default: 20
Example: size=size=20

The size of the page to be returned.

name
string
Example: name=name=charles

Filter by user name. Note that user name is case insensitive.

workspace
string
Example: workspace=workspace=demo

Filter by workspaceId.

group
string
Example: group=group=admin

Filter by userGroupId.

dataSource
string
Example: dataSource=dataSource=demo-test-ds

Filter by dataSourceId.

Responses

Response samples

Content type
application/json
{
  • "totalCount": 0,
  • "users": [
    ]
}

listPermissionsForUser

path Parameters
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "dataSources": [
    ],
  • "workspaces": [
    ]
}

managePermissionsForUser

path Parameters
userId
required
string
Request Body schema: application/json
required
Array of objects (UserManagementDataSourcePermissionAssignment) [ items ]
required
Array of objects (UserManagementWorkspacePermissionAssignment) [ items ]

Responses

Request samples

Content type
application/json
{
  • "dataSources": [
    ],
  • "workspaces": [
    ]
}

Permissions

Manage Permissions for a Data Source

Manage Permissions for a Data Source

path Parameters
dataSourceId
required
string
Request Body schema: application/json
Array
required
object (AssigneeIdentifier)

Identifier of a user or user-group.

permissions
required
Array of strings
Items Enum: "MANAGE" "USE"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Manage Permissions for a Organization

Manage Permissions for a Organization

Request Body schema: application/json
Array
required
object (AssigneeIdentifier)

Identifier of a user or user-group.

permissions
required
Array of strings
Items Enum: "MANAGE" "SELF_CREATE_TOKEN"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get Available Assignees

path Parameters
workspaceId
required
string
dashboardId
required
string

Responses

Response samples

Content type
application/json
{
  • "userGroups": [
    ],
  • "users": [
    ]
}

Manage Permissions for a Dashboard

path Parameters
workspaceId
required
string
dashboardId
required
string
Request Body schema: application/json
Array
One of
permissions
required
Array of strings
Items Enum: "EDIT" "SHARE" "VIEW"
required
object (AssigneeIdentifier)

Identifier of a user or user-group.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get Dashboard Permissions

path Parameters
workspaceId
required
string
dashboardId
required
string

Responses

Response samples

Content type
application/json
{
  • "rules": [
    ],
  • "userGroups": [
    ],
  • "users": [
    ]
}

Manage Permissions for a Workspace

Manage Permissions for a Workspace and its Workspace Hierarchy

path Parameters
workspaceId
required
string
Request Body schema: application/json
Array
required
object (AssigneeIdentifier)

Identifier of a user or user-group.

hierarchyPermissions
Array of strings
Items Enum: "MANAGE" "ANALYZE" "EXPORT" "EXPORT_TABULAR" "EXPORT_PDF" "CREATE_AUTOMATION" "CREATE_FILTER_VIEW" "VIEW"
permissions
Array of strings
Items Enum: "MANAGE" "ANALYZE" "EXPORT" "EXPORT_TABULAR" "EXPORT_PDF" "CREATE_AUTOMATION" "CREATE_FILTER_VIEW" "VIEW"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get organization permissions

Retrieve organization permissions

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set organization permissions

Sets organization permissions

Request Body schema: application/json
Array
required
object (AssigneeIdentifier)

Identifier of a user or user-group.

name
required
string
Enum: "MANAGE" "SELF_CREATE_TOKEN"

Permission name.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get permissions for the user-group

Retrieve current set of permissions of the user-group in a declarative form.

path Parameters
userGroupId
required
string

Responses

Response samples

Content type
application/json
{
  • "permissions": [
    ]
}

Set permissions for the user-group

Set effective permissions for the user-group

path Parameters
userGroupId
required
string
Request Body schema: application/json
Array of objects (DeclarativeUserGroupPermission) [ items ]

Responses

Request samples

Content type
application/json
{
  • "permissions": [
    ]
}

Get permissions for the user

Retrieve current set of permissions of the user in a declarative form.

path Parameters
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "permissions": [
    ]
}

Set permissions for the user

Set effective permissions for the user

path Parameters
userId
required
string
Request Body schema: application/json
Array of objects (DeclarativeUserPermission) [ items ]

Responses

Request samples

Content type
application/json
{
  • "permissions": [
    ]
}

Get permissions for the workspace

Retrieve current set of permissions of the workspace in a declarative form.

path Parameters
workspaceId
required
string

Responses

Response samples

Content type
application/json
{
  • "hierarchyPermissions": [
    ],
  • "permissions": [
    ]
}

Set permissions for the workspace

Set effective permissions for the workspace

path Parameters
workspaceId
required
string
Request Body schema: application/json
Array of objects (DeclarativeWorkspaceHierarchyPermission) [ items ]
Array of objects (DeclarativeSingleWorkspacePermission) [ items ]

Responses

Request samples

Content type
application/json
{
  • "hierarchyPermissions": [
    ],
  • "permissions": [
    ]
}

Data Source - Declarative APIs

Get all data sources

Retrieve all data sources including related physical model.

Responses

Response samples

Content type
application/json
{
  • "dataSources": [
    ]
}

Put all data sources

Set all data sources including related physical model.

Request Body schema: application/json
required
Array of objects (DeclarativeDataSource) [ items ]

Responses

Request samples

Content type
application/json
{
  • "dataSources": [
    ]
}

Data Source - Entity APIs

Get all Data Source Identifiers

query Parameters
filter
string
Example: filter=filter=name==someString;schema==someString

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').

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "permissions" "page" "all" "ALL"
Example: metaInclude=metaInclude=permissions,page,all

Include Meta objects.

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get Data Source Identifier

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString;schema==someString

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').

metaInclude
Array of strings unique
Items Enum: "permissions" "all" "ALL"
Example: metaInclude=metaInclude=permissions,all

Include Meta objects.

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Get Data Source entities

Data Source - represents data source for the workspace

query Parameters
filter
string
Example: filter=filter=name==someString;type==DatabaseTypeValue

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').

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "permissions" "page" "all" "ALL"
Example: metaInclude=metaInclude=permissions,page,all

Include Meta objects.

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post Data Sources

Data Source - represents data source for the workspace

query Parameters
metaInclude
Array of strings unique
Items Enum: "permissions" "all" "ALL"
Example: metaInclude=metaInclude=permissions,all

Include Meta objects.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiDataSourceIn)

JSON:API representation of dataSource entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Delete Data Source entity

Data Source - represents data source for the workspace

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString;type==DatabaseTypeValue

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').

Responses

Get Data Source entity

Data Source - represents data source for the workspace

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString;type==DatabaseTypeValue

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').

metaInclude
Array of strings unique
Items Enum: "permissions" "all" "ALL"
Example: metaInclude=metaInclude=permissions,all

Include Meta objects.

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Patch Data Source entity

Data Source - represents data source for the workspace

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString;type==DatabaseTypeValue

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').

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiDataSourcePatch)

JSON:API representation of patching dataSource entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Put Data Source entity

Data Source - represents data source for the workspace

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString;type==DatabaseTypeValue

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').

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiDataSourceIn)

JSON:API representation of dataSource entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Test Connection

Test connection by data source definition

Test if it is possible to connect to a database using a connection provided by the data source definition in the request body.

Request Body schema: application/json
clientId
string

Id for client based authentication for data sources which supports it.

clientSecret
string

Secret for client based authentication for data sources which supports it.

Array of objects (DataSourceParameter) [ items ]
password
string

Database user password.

privateKey
string

Private key for data sources which supports key-pair authentication.

privateKeyPassphrase
string

Passphrase for a encrypted version of a private key.

schema
string

Database schema.

token
string

Secret for token based authentication for data sources which supports it.

type
required
string
Enum: "POSTGRESQL" "REDSHIFT" "VERTICA" "SNOWFLAKE" "ADS" "BIGQUERY" "MSSQL" "PRESTO" "DREMIO" "DRILL" "GREENPLUM" "AZURESQL" "SYNAPSESQL" "DATABRICKS" "GDSTORAGE" "CLICKHOUSE" "MYSQL" "MARIADB" "ORACLE" "PINOT" "SINGLESTORE" "MOTHERDUCK" "FLEXCONNECT"

Type of database, where test should connect to.

url
string

URL to database in JDBC format, where test should connect to.

username
string

Database user name.

Responses

Request samples

Content type
application/json
{
  • "clientId": "string",
  • "clientSecret": "string",
  • "parameters": [
    ],
  • "password": "admin123",
  • "privateKey": "string",
  • "privateKeyPassphrase": "string",
  • "schema": "public",
  • "token": "string",
  • "type": "POSTGRESQL",
  • "url": "jdbc:postgresql://localhost:5432/db_name",
  • "username": "dbadmin"
}

Response samples

Content type
application/json
Example
An example of a successful connection
An example of a successful connection
An example of an unsuccessful connection

An example of a successful connection

{
  • "queryDurationMillis": {
    },
  • "successful": true
}

Test data source connection by data source id

Test if it is possible to connect to a database using an existing data source definition.

path Parameters
dataSourceId
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
Example: myPostgres

Data source id

Request Body schema: application/json
clientId
string

Id for client based authentication for data sources which supports it.

clientSecret
string

Secret for client based authentication for data sources which supports it.

Array of objects (DataSourceParameter) [ items ]
password
string

Database user password.

privateKey
string

Private key for data sources which supports key-pair authentication.

privateKeyPassphrase
string

Passphrase for a encrypted version of a private key.

schema
string

Database schema.

token
string

Secret for token based authentication for data sources which supports it.

url
string

URL to database in JDBC format, where test should connect to.

username
string

Database user name.

Responses

Request samples

Content type
application/json
{
  • "clientId": "string",
  • "clientSecret": "string",
  • "parameters": [
    ],
  • "password": "admin123",
  • "privateKey": "string",
  • "privateKeyPassphrase": "string",
  • "schema": "public",
  • "token": "string",
  • "url": "jdbc:postgresql://localhost:5432/db_name",
  • "username": "dbadmin"
}

Response samples

Content type
application/json
Example
An example of a successful connection
An example of a successful connection
An example of an unsuccessful connection

An example of a successful connection

{
  • "queryDurationMillis": {
    },
  • "successful": true
}

Invalidate Cache

Register an upload notification

Notification sets up all reports to be computed again with new data.

path Parameters
dataSourceId
required
string

Responses

Manage Permissions

Manage Permissions for a Data Source

Manage Permissions for a Data Source

path Parameters
dataSourceId
required
string
Request Body schema: application/json
Array
required
object (AssigneeIdentifier)

Identifier of a user or user-group.

permissions
required
Array of strings
Items Enum: "MANAGE" "USE"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Get permissions for the data source

Retrieve current set of permissions of the data source in a declarative form.

path Parameters
dataSourceId
required
string

Responses

Response samples

Content type
application/json
{
  • "permissions": [
    ]
}

Set data source permissions.

set data source permissions.

path Parameters
dataSourceId
required
string
Request Body schema: application/json
Array of objects (DeclarativeDataSourcePermission) [ items ]

Responses

Request samples

Content type
application/json
{
  • "permissions": [
    ]
}

Available Drivers

Get all available data source drivers

Retrieves a list of all supported data sources along with information about the used drivers.

Responses

Response samples

Content type
application/json

All available drivers

{
  • "POSTGRESQL": "org.postgresql.Driver",
  • "REDSHIFT": "com.amazon.redshift.jdbc42.Driver"
}

Scanning

Scan a database to get a physical data model (PDM)

It scans a database and transforms its metadata to a declarative definition of the physical data model (PDM). The result of the request contains the mentioned physical data model (PDM) of a database within warning, for example, about unsupported columns.

path Parameters
dataSourceId
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
Example: myPostgres

Data source id

Request Body schema: application/json
scanTables
required
boolean

A flag indicating whether the tables should be scanned.

scanViews
required
boolean

A flag indicating whether the views should be scanned.

schemata
Array of strings

What schemata will be scanned.

separator
required
string

A separator between prefixes and the names.

tablePrefix
string

Tables starting with this prefix will be scanned. The prefix is then followed by the value of separator parameter. Given the table prefix is out_table and separator is __, the table with name like out_table__customers will be scanned.

viewPrefix
string

Views starting with this prefix will be scanned. The prefix is then followed by the value of separator parameter. Given the view prefix is out_view and separator is __, the table with name like out_view__us_customers will be scanned.

Responses

Request samples

Content type
application/json
{
  • "scanTables": true,
  • "scanViews": true,
  • "schemata": [
    ],
  • "separator": "__",
  • "tablePrefix": "out_table",
  • "viewPrefix": "out_view"
}

Response samples

Content type
application/json

An example of a successful scan

{
  • "pdm": {
    },
  • "warnings": [ ]
}

Get a list of schema names of a database

It scans a database and reads metadata. The result of the request contains a list of schema names of a database.

path Parameters
dataSourceId
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
Example: myPostgres

Data source id

Responses

Response samples

Content type
application/json

An example of a successful scan

{
  • "schemaNames": [
    ]
}

Collect metadata about SQL query

It executes SQL query against specified data source and extracts metadata. Metadata consist of column names and column data types. It can optionally provide also preview of data returned by SQL query

path Parameters
dataSourceId
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
Example: myPostgres

Data source id

Request Body schema: application/json
sql
required
string

SQL query to be analyzed.

Responses

Request samples

Content type
application/json
{
  • "sql": "SELECT a.special_value as result FROM tableA a"
}

Response samples

Content type
application/json

An example of a successful scan

{
  • "columns": [
    ],
  • "dataPreview": [
    ]
}

Data source files import

Import CSV

Import the CSV files at the given locations in the staging area to the final location.

path Parameters
dataSourceId
required
string
Request Body schema: application/json
required
Array of objects (ImportCsvRequestTable) [ items ]

Information about the individual tables.

Responses

Request samples

Content type
application/json
{
  • "tables": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Data source files analysis

Analyze CSV

Analyzes CSV files at the given locations

Request Body schema: application/json
required
Array of objects (AnalyzeCsvRequestItem) [ items ]

List of individual CSV analysis requests.

Responses

Request samples

Content type
application/json
{
  • "analyzeRequests": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Data source staging location

Upload a file to the staging area

Provides a location for uploading staging files.

Request Body schema: multipart/form-data
file
required
string <binary>

The file to upload.

Responses

Response samples

Content type
application/json
{
  • "location": "string"
}

Data source files listing

List datasource files

List all the files in the given data source.

path Parameters
dataSourceId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Data source files deletion

Delete datasource files

Delete the files in the given data source.

path Parameters
dataSourceId
required
string
Request Body schema: application/json
fileNames
required
Array of strings

Names of the files to delete.

Responses

Request samples

Content type
application/json
{
  • "fileNames": [
    ]
}

Data source files manifest read

Read CSV file manifests

Read the manifests of the CSV files in the given data source.

path Parameters
dataSourceId
required
string
Request Body schema: application/json
required
Array of objects (ReadCsvFileManifestsRequestItem) [ items ]

Files to read the manifests for.

Responses

Request samples

Content type
application/json
{
  • "manifestRequests": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Workspaces - Entity APIs

Get Workspace entities

Space of the shared interest

query Parameters
filter
string
Example: filter=filter=name==someString;earlyAccess==someString;parent.id==321

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').

include
Array of strings
Items Enum: "workspaces" "parent" "ALL"
Example: include=include=parent

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.

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "permissions" "config" "hierarchy" "dataModelDatasets" "page" "all" "ALL"
Example: metaInclude=metaInclude=permissions,config,hierarchy,dataModelDatasets,page,all

Include Meta objects.

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "included": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post Workspace entities

Space of the shared interest

query Parameters
include
Array of strings
Items Enum: "workspaces" "parent" "ALL"
Example: include=include=parent

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.

metaInclude
Array of strings unique
Items Enum: "permissions" "config" "hierarchy" "dataModelDatasets" "all" "ALL"
Example: metaInclude=metaInclude=permissions,config,hierarchy,dataModelDatasets,all

Include Meta objects.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiWorkspaceIn)

JSON:API representation of workspace entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Delete Workspace entity

Space of the shared interest

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString;earlyAccess==someString;parent.id==321

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').

Responses

Get Workspace entity

Space of the shared interest

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString;earlyAccess==someString;parent.id==321

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').

include
Array of strings
Items Enum: "workspaces" "parent" "ALL"
Example: include=include=parent

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.

metaInclude
Array of strings unique
Items Enum: "permissions" "config" "hierarchy" "dataModelDatasets" "all" "ALL"
Example: metaInclude=metaInclude=permissions,config,hierarchy,dataModelDatasets,all

Include Meta objects.

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Patch Workspace entity

Space of the shared interest

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString;earlyAccess==someString;parent.id==321

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').

include
Array of strings
Items Enum: "workspaces" "parent" "ALL"
Example: include=include=parent

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiWorkspacePatch)

JSON:API representation of patching workspace entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Put Workspace entity

Space of the shared interest

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString;earlyAccess==someString;parent.id==321

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').

include
Array of strings
Items Enum: "workspaces" "parent" "ALL"
Example: include=include=parent

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiWorkspaceIn)

JSON:API representation of workspace entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Workspaces - Declarative APIs

Get all workspaces layout

Gets complete layout of workspaces, their hierarchy, models.

query Parameters
exclude
Array of strings
Items Value: "ACTIVITY_INFO"

Responses

Response samples

Content type
application/json
{
  • "workspaceDataFilters": [
    ],
  • "workspaces": [
    ]
}

Set all workspaces layout

Sets complete layout of workspaces, their hierarchy, models.

Request Body schema: application/json
required
Array of objects (DeclarativeWorkspaceDataFilter) [ items ]
required
Array of objects (DeclarativeWorkspace) [ items ]

Responses

Request samples

Content type
application/json
{
  • "workspaceDataFilters": [
    ],
  • "workspaces": [
    ]
}

Get workspace layout

Retrieve current model of the workspace in declarative form.

path Parameters
workspaceId
required
string
query Parameters
exclude
Array of strings
Items Value: "ACTIVITY_INFO"

Responses

Response samples

Content type
application/json
{
  • "analytics": {
    },
  • "ldm": {
    }
}

Set workspace layout

Set complete layout of workspace, like model, authorization, etc.

path Parameters
workspaceId
required
string
Request Body schema: application/json
object (DeclarativeAnalyticsLayer)
object (DeclarativeLdm)

A logical data model (LDM) representation.

Responses

Request samples

Content type
application/json
{
  • "analytics": {
    },
  • "ldm": {
    }
}

Data Filters

Get all User Data Filters

path Parameters
workspaceId
required
string
query Parameters
origin
string
Default: "ALL"
Enum: "ALL" "PARENTS" "NATIVE"

Defines scope of origin of objects. All by default.

filter
string
Example: filter=filter=title==someString;description==someString;user.id==321;userGroup.id==321

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').

include
Array of strings
Items Enum: "users" "userGroups" "facts" "attributes" "labels" "metrics" "datasets" "user" "userGroup" "ALL"
Example: include=include=user,userGroup,facts,attributes,labels,metrics,datasets

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.

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "origin" "page" "all" "ALL"
Example: metaInclude=metaInclude=origin,page,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "included": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post User Data Filters

path Parameters
workspaceId
required
string
query Parameters
include
Array of strings
Items Enum: "users" "userGroups" "facts" "attributes" "labels" "metrics" "datasets" "user" "userGroup" "ALL"
Example: include=include=user,userGroup,facts,attributes,labels,metrics,datasets

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.

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiUserDataFilterPostOptionalId)

JSON:API representation of userDataFilter entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Delete a User Data Filter

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;user.id==321;userGroup.id==321

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').

Responses

Get a User Data Filter

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;user.id==321;userGroup.id==321

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').

include
Array of strings
Items Enum: "users" "userGroups" "facts" "attributes" "labels" "metrics" "datasets" "user" "userGroup" "ALL"
Example: include=include=user,userGroup,facts,attributes,labels,metrics,datasets

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.

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Patch a User Data Filter

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;user.id==321;userGroup.id==321

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').

include
Array of strings
Items Enum: "users" "userGroups" "facts" "attributes" "labels" "metrics" "datasets" "user" "userGroup" "ALL"
Example: include=include=user,userGroup,facts,attributes,labels,metrics,datasets

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiUserDataFilterPatch)

JSON:API representation of patching userDataFilter entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Put a User Data Filter

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;user.id==321;userGroup.id==321

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').

include
Array of strings
Items Enum: "users" "userGroups" "facts" "attributes" "labels" "metrics" "datasets" "user" "userGroup" "ALL"
Example: include=include=user,userGroup,facts,attributes,labels,metrics,datasets

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiUserDataFilterIn)

JSON:API representation of userDataFilter entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Get all Settings for Workspace Data Filters

path Parameters
workspaceId
required
string
query Parameters
origin
string
Default: "ALL"
Enum: "ALL" "PARENTS" "NATIVE"

Defines scope of origin of objects. All by default.

filter
string
Example: filter=filter=title==someString;description==someString;workspaceDataFilter.id==321

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').

include
Array of strings
Items Enum: "workspaceDataFilters" "workspaceDataFilter" "ALL"
Example: include=include=workspaceDataFilter

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.

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "origin" "page" "all" "ALL"
Example: metaInclude=metaInclude=origin,page,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "included": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post Settings for Workspace Data Filters

path Parameters
workspaceId
required
string
query Parameters
include
Array of strings
Items Enum: "workspaceDataFilters" "workspaceDataFilter" "ALL"
Example: include=include=workspaceDataFilter

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.

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiWorkspaceDataFilterSettingIn)

JSON:API representation of workspaceDataFilterSetting entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Delete a Settings for Workspace Data Filter

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;workspaceDataFilter.id==321

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').

Responses

Get a Setting for Workspace Data Filter

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;workspaceDataFilter.id==321

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').

include
Array of strings
Items Enum: "workspaceDataFilters" "workspaceDataFilter" "ALL"
Example: include=include=workspaceDataFilter

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.

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Patch a Settings for Workspace Data Filter

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;workspaceDataFilter.id==321

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').

include
Array of strings
Items Enum: "workspaceDataFilters" "workspaceDataFilter" "ALL"
Example: include=include=workspaceDataFilter

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiWorkspaceDataFilterSettingPatch)

JSON:API representation of patching workspaceDataFilterSetting entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Put a Settings for Workspace Data Filter

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;workspaceDataFilter.id==321

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').

include
Array of strings
Items Enum: "workspaceDataFilters" "workspaceDataFilter" "ALL"
Example: include=include=workspaceDataFilter

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiWorkspaceDataFilterSettingIn)

JSON:API representation of workspaceDataFilterSetting entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Get all Workspace Data Filters

path Parameters
workspaceId
required
string
query Parameters
origin
string
Default: "ALL"
Enum: "ALL" "PARENTS" "NATIVE"

Defines scope of origin of objects. All by default.

filter
string
Example: filter=filter=title==someString;description==someString

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').

include
Array of strings
Items Enum: "workspaceDataFilterSettings" "filterSettings" "ALL"
Example: include=include=filterSettings

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.

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "origin" "page" "all" "ALL"
Example: metaInclude=metaInclude=origin,page,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "included": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post Workspace Data Filters

path Parameters
workspaceId
required
string
query Parameters
include
Array of strings
Items Enum: "workspaceDataFilterSettings" "filterSettings" "ALL"
Example: include=include=filterSettings

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.

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiWorkspaceDataFilterIn)

JSON:API representation of workspaceDataFilter entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Delete a Workspace Data Filter

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString

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').

Responses

Get a Workspace Data Filter

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString

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').

include
Array of strings
Items Enum: "workspaceDataFilterSettings" "filterSettings" "ALL"
Example: include=include=filterSettings

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.

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Patch a Workspace Data Filter

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString

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').

include
Array of strings
Items Enum: "workspaceDataFilterSettings" "filterSettings" "ALL"
Example: include=include=filterSettings

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiWorkspaceDataFilterPatch)

JSON:API representation of patching workspaceDataFilter entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Put a Workspace Data Filter

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString

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').

include
Array of strings
Items Enum: "workspaceDataFilterSettings" "filterSettings" "ALL"
Example: include=include=filterSettings

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiWorkspaceDataFilterIn)

JSON:API representation of workspaceDataFilter entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Get workspace data filters for all workspaces

Retrieve all workspaces and related workspace data filters (and their settings / values).

Responses

Response samples

Content type
application/json
{
  • "workspaceDataFilters": [
    ]
}

Set all workspace data filters

Sets workspace data filters in all workspaces in entire organization.

Request Body schema: application/json
required
Array of objects (DeclarativeWorkspaceDataFilter) [ items ]

Responses

Request samples

Content type
application/json
{
  • "workspaceDataFilters": [
    ]
}

Workspaces - Settings

Values for all settings.

Resolves values for all settings in a workspace by current user, workspace, organization, or default settings.

path Parameters
workspaceId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Values for selected settings.

Resolves value for selected settings in a workspace by current user, workspace, organization, or default settings.

path Parameters
workspaceId
required
string
Request Body schema: application/json
settings
required
Array of strings

An array of setting IDs to resolve.

Responses

Request samples

Content type
application/json
{
  • "settings": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get all Custom Application Settings

path Parameters
workspaceId
required
string
query Parameters
origin
string
Default: "ALL"
Enum: "ALL" "PARENTS" "NATIVE"

Defines scope of origin of objects. All by default.

filter
string
Example: filter=filter=applicationName==someString;content==JsonNodeValue

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').

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "origin" "page" "all" "ALL"
Example: metaInclude=metaInclude=origin,page,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post Custom Application Settings

path Parameters
workspaceId
required
string
query Parameters
metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiCustomApplicationSettingPostOptionalId)

JSON:API representation of customApplicationSetting entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Delete a Custom Application Setting

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=applicationName==someString;content==JsonNodeValue

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').

Responses

Get a Custom Application Setting

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=applicationName==someString;content==JsonNodeValue

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').

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Patch a Custom Application Setting

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=applicationName==someString;content==JsonNodeValue

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').

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiCustomApplicationSettingPatch)

JSON:API representation of patching customApplicationSetting entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Put a Custom Application Setting

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=applicationName==someString;content==JsonNodeValue

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').

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiCustomApplicationSettingIn)

JSON:API representation of customApplicationSetting entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Get all Setting for Workspaces

path Parameters
workspaceId
required
string
query Parameters
origin
string
Default: "ALL"
Enum: "ALL" "PARENTS" "NATIVE"

Defines scope of origin of objects. All by default.

filter
string
Example: filter=filter=content==JsonNodeValue;type==SettingTypeValue

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').

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "origin" "page" "all" "ALL"
Example: metaInclude=metaInclude=origin,page,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post Settings for Workspaces

path Parameters
workspaceId
required
string
query Parameters
metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiWorkspaceSettingPostOptionalId)

JSON:API representation of workspaceSetting entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Delete a Setting for Workspace

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=content==JsonNodeValue;type==SettingTypeValue

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').

Responses

Get a Setting for Workspace

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=content==JsonNodeValue;type==SettingTypeValue

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').

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Patch a Setting for Workspace

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=content==JsonNodeValue;type==SettingTypeValue

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').

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiWorkspaceSettingPatch)

JSON:API representation of patching workspaceSetting entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Put a Setting for a Workspace

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=content==JsonNodeValue;type==SettingTypeValue

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').

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiWorkspaceSettingIn)

JSON:API representation of workspaceSetting entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Appearance

Get all Color Pallettes

query Parameters
filter
string
Example: filter=filter=name==someString;content==JsonNodeValue

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').

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "page" "all" "ALL"
Example: metaInclude=metaInclude=page,all

Include Meta objects.

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post Color Pallettes

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiColorPaletteIn)

JSON:API representation of colorPalette entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Delete a Color Pallette

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString;content==JsonNodeValue

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').

Responses

Get Color Pallette

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString;content==JsonNodeValue

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').

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Patch Color Pallette

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString;content==JsonNodeValue

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').

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiColorPalettePatch)

JSON:API representation of patching colorPalette entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Put Color Pallette

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString;content==JsonNodeValue

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').

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiColorPaletteIn)

JSON:API representation of colorPalette entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Get all Theming entities

query Parameters
filter
string
Example: filter=filter=name==someString;content==JsonNodeValue

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').

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "page" "all" "ALL"
Example: metaInclude=metaInclude=page,all

Include Meta objects.

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post Theming

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiThemeIn)

JSON:API representation of theme entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Delete Theming

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString;content==JsonNodeValue

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').

Responses

Get Theming

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString;content==JsonNodeValue

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').

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Patch Theming

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString;content==JsonNodeValue

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').

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiThemePatch)

JSON:API representation of patching theme entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Put Theming

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=name==someString;content==JsonNodeValue

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').

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiThemeIn)

JSON:API representation of theme entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Plugins

Get all Plugins

path Parameters
workspaceId
required
string
query Parameters
origin
string
Default: "ALL"
Enum: "ALL" "PARENTS" "NATIVE"

Defines scope of origin of objects. All by default.

filter
string
Example: filter=filter=title==someString;description==someString;createdBy.id==321;modifiedBy.id==321

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').

include
Array of strings
Items Enum: "userIdentifiers" "createdBy" "modifiedBy" "ALL"
Example: include=include=createdBy,modifiedBy

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.

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "origin" "page" "all" "ALL"
Example: metaInclude=metaInclude=origin,page,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "included": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post Plugins

path Parameters
workspaceId
required
string
query Parameters
include
Array of strings
Items Enum: "userIdentifiers" "createdBy" "modifiedBy" "ALL"
Example: include=include=createdBy,modifiedBy

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.

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiDashboardPluginPostOptionalId)

JSON:API representation of dashboardPlugin entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Delete a Plugin

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;createdBy.id==321;modifiedBy.id==321

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').

Responses

Get a Plugin

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;createdBy.id==321;modifiedBy.id==321

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').

include
Array of strings
Items Enum: "userIdentifiers" "createdBy" "modifiedBy" "ALL"
Example: include=include=createdBy,modifiedBy

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.

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Patch a Plugin

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;createdBy.id==321;modifiedBy.id==321

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').

include
Array of strings
Items Enum: "userIdentifiers" "createdBy" "modifiedBy" "ALL"
Example: include=include=createdBy,modifiedBy

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiDashboardPluginPatch)

JSON:API representation of patching dashboardPlugin entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Put a Plugin

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;createdBy.id==321;modifiedBy.id==321

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').

include
Array of strings
Items Enum: "userIdentifiers" "createdBy" "modifiedBy" "ALL"
Example: include=include=createdBy,modifiedBy

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiDashboardPluginIn)

JSON:API representation of dashboardPlugin entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Hierarchy

Finds entities with given ID in hierarchy.

Finds entities with given ID in hierarchy (e.g. to check possible future conflicts).

path Parameters
workspaceId
required
string
Request Body schema: application/json
Array
id
required
string
type
required
string
Enum: "analyticalDashboard" "attribute" "dashboardPlugin" "dataset" "fact" "label" "metric" "prompt" "visualizationObject" "filterContext" "workspaceDataFilter" "workspaceDataFilterSettings"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Finds identifier conflicts in workspace hierarchy.

Finds API identifier conflicts in given workspace hierarchy.

path Parameters
workspaceId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get used entity prefixes in hierarchy

Get used entity prefixes in hierarchy of parent workspaces

path Parameters
workspaceId
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Finds identifier overrides in workspace hierarchy.

Finds API identifier overrides in given workspace hierarchy.

path Parameters
workspaceId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Translations

Get translation tags.

Provides a list of effective translation tags.

path Parameters
workspaceId
required
string

Responses

Response samples

Content type
application/json
[
  • "string"
]

Cleans up translations.

Cleans up all translations for a particular locale.

path Parameters
workspaceId
required
string
Request Body schema: application/json
locale
required
string

Requested locale in the form of language tag (see RFC 5646).

Responses

Request samples

Content type
application/json
{
  • "locale": "en-US"
}

Retrieve translations for entities.

Retrieve all translation for existing entities in a particular locale. The source translations returned by this endpoint are always original, not translated, texts. Because the XLIFF schema definition has the 'xs:language' constraint for the 'srcLang' attribute, it is always set to 'en-US' value.

path Parameters
workspaceId
required
string
Request Body schema: application/json
locale
required
string

Requested locale in the form of language tag (see RFC 5646).

Responses

Request samples

Content type
application/json
{
  • "locale": "en-US"
}

Set translations for entities.

Set translation for existing entities in a particular locale.

path Parameters
workspaceId
required
string
Request Body schema: application/xml
required
Array of objects (File) [ items ]
object
space
string
srcLang
string
trgLang
string
version
string

Responses

Generate Logical Data Model

Generate logical data model (LDM) from physical data model (PDM)

Generate logical data model (LDM) from physical data model (PDM) stored in data source.

path Parameters
dataSourceId
required
string
Request Body schema: application/json
dateGranularities
string

Option to control date granularities for date datasets. Empty value enables common date granularities (DAY, WEEK, MONTH, QUARTER, YEAR). Default value is all which enables all available date granularities, including time granularities (like hours, minutes).

denormPrefix
string

Columns starting with this prefix will be considered as denormalization references. The prefix is then followed by the value of separator parameter. Given the denormalization reference prefix is dr and separator is __, the columns with name like dr__customer_name will be considered as denormalization references.

factPrefix
string

Columns starting with this prefix will be considered as facts. The prefix is then followed by the value of separator parameter. Given the fact prefix is f and separator is __, the columns with name like f__sold will be considered as facts.

generateLongIds
boolean
Default: false

A flag dictating how the attribute, fact and label ids are generated. By default their ids are derived only from the column name, unless there would be a conflict (e.g. category coming from two different tables). In that case a long id format of <table>.<column> is used. If the flag is set to true, then all ids will be generated in the long form.

grainMultivalueReferencePrefix
string

Columns starting with this prefix will be considered as grain multivalue references. The prefix is then followed by the value of separator parameter. Given the reference prefix is grmr and separator is __, the columns with name like grmr__customer__customer_id will be considered as grain multivalue references to customer_id in customer table.

grainPrefix
string

Columns starting with this prefix will be considered as grains. The prefix is then followed by the value of separator parameter. Given the grain prefix is gr and separator is __, the columns with name like gr__name will be considered as grains.

grainReferencePrefix
string

Columns starting with this prefix will be considered as grain references. The prefix is then followed by the value of separator parameter. For composite references, the reference is multivalue if at least one column is multivalue. Given the reference prefix is grr and separator is __, the columns with name like grr__customer__customer_id will be considered as grain references to customer_id in customer table.

multivalueReferencePrefix
string

Columns starting with this prefix will be considered as multivalue references. The prefix is then followed by the value of separator parameter. For composite references, the reference is multivalue if at least one column is multivalue. Given the reference prefix is mr and separator is __, the columns with name like mr__customer__customer_id will be considered as multivalue references to customer_id in customer table.

object (PdmLdmRequest)

PDM additions wrapper.

primaryLabelPrefix
string

Columns starting with this prefix will be considered as primary labels. The prefix is then followed by the value of separator parameter. Given the primary label prefix is pl and separator is __, the columns with name like pl__country_id will be considered as primary labels.

referencePrefix
string

Columns starting with this prefix will be considered as references. The prefix is then followed by the value of separator parameter. Given the reference prefix is r and separator is __, the columns with name like r__customer__customer_id will be considered as references to customer_id in customer table.

secondaryLabelPrefix
string

Columns starting with this prefix will be considered as secondary labels. The prefix is then followed by the value of separator parameter. Given the secondary label prefix is ls and separator is __, the columns with name like ls__country_id__country_name will be considered as secondary labels.

separator
string
Default: "__"

A separator between prefixes and the names. Default is "__".

tablePrefix
string
Deprecated

Tables starting with this prefix will be included. The prefix is then followed by the value of separator parameter. Given the table prefix is out_table and separator is __, the table with name like out_table__customers will be scanned.

viewPrefix
string
Deprecated

Views starting with this prefix will be included. The prefix is then followed by the value of separator parameter. Given the view prefix is out_view and separator is __, the table with name like out_view__us_customers will be scanned.

wdfPrefix
string
Default: "wdf"

Column serving as workspace data filter. No labels are auto generated for such columns.

workspaceId
string

Optional workspace id.

Responses

Request samples

Content type
application/json
{
  • "dateGranularities": "all",
  • "denormPrefix": "dr",
  • "factPrefix": "f",
  • "generateLongIds": false,
  • "grainMultivalueReferencePrefix": "grmr",
  • "grainPrefix": "gr",
  • "grainReferencePrefix": "grr",
  • "multivalueReferencePrefix": "mr",
  • "pdm": {
    },
  • "primaryLabelPrefix": "pl",
  • "referencePrefix": "r",
  • "secondaryLabelPrefix": "ls",
  • "separator": "__",
  • "tablePrefix": "out_table",
  • "viewPrefix": "out_view",
  • "wdfPrefix": "wdf",
  • "workspaceId": "string"
}

Response samples

Content type
application/json
{
  • "ldm": {
    }
}

LDM - Declarative APIs

Get logical model

Retrieve current logical model of the workspace in declarative form.

path Parameters
workspaceId
required
string
query Parameters
includeParents
boolean

Responses

Response samples

Content type
application/json
{
  • "ldm": {
    }
}

Set logical model

Set effective logical model of the workspace.

path Parameters
workspaceId
required
string
Request Body schema: application/json
object (DeclarativeLdm)

A logical data model (LDM) representation.

Responses

Request samples

Content type
application/json
{
  • "ldm": {
    }
}

Datasets

Get all Datasets

path Parameters
workspaceId
required
string
query Parameters
origin
string
Default: "ALL"
Enum: "ALL" "PARENTS" "NATIVE"

Defines scope of origin of objects. All by default.

filter
string
Example: filter=filter=title==someString;description==someString

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').

include
Array of strings
Items Enum: "attributes" "facts" "datasets" "workspaceDataFilters" "references" "ALL"
Example: include=include=attributes,facts,references,workspaceDataFilters

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.

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "origin" "page" "all" "ALL"
Example: metaInclude=metaInclude=origin,page,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "included": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get a Dataset

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString

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').

include
Array of strings
Items Enum: "attributes" "facts" "datasets" "workspaceDataFilters" "references" "ALL"
Example: include=include=attributes,facts,references,workspaceDataFilters

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.

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Attributes

Get all Attributes

path Parameters
workspaceId
required
string
query Parameters
origin
string
Default: "ALL"
Enum: "ALL" "PARENTS" "NATIVE"

Defines scope of origin of objects. All by default.

filter
string
Example: filter=filter=title==someString;description==someString;dataset.id==321;defaultView.id==321

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').

include
Array of strings
Items Enum: "datasets" "labels" "attributeHierarchies" "dataset" "defaultView" "ALL"
Example: include=include=dataset,defaultView,labels,attributeHierarchies

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.

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "origin" "page" "all" "ALL"
Example: metaInclude=metaInclude=origin,page,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "included": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get an Attribute

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;dataset.id==321;defaultView.id==321

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').

include
Array of strings
Items Enum: "datasets" "labels" "attributeHierarchies" "dataset" "defaultView" "ALL"
Example: include=include=dataset,defaultView,labels,attributeHierarchies

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.

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Facts

Get all Facts

path Parameters
workspaceId
required
string
query Parameters
origin
string
Default: "ALL"
Enum: "ALL" "PARENTS" "NATIVE"

Defines scope of origin of objects. All by default.

filter
string
Example: filter=filter=title==someString;description==someString;dataset.id==321

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').

include
Array of strings
Items Enum: "datasets" "dataset" "ALL"
Example: include=include=dataset

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.

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "origin" "page" "all" "ALL"
Example: metaInclude=metaInclude=origin,page,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "included": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get a Fact

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;dataset.id==321

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').

include
Array of strings
Items Enum: "datasets" "dataset" "ALL"
Example: include=include=dataset

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.

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Labels

Get all Labels

path Parameters
workspaceId
required
string
query Parameters
origin
string
Default: "ALL"
Enum: "ALL" "PARENTS" "NATIVE"

Defines scope of origin of objects. All by default.

filter
string
Example: filter=filter=title==someString;description==someString;attribute.id==321

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').

include
Array of strings
Items Enum: "attributes" "attribute" "ALL"
Example: include=include=attribute

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.

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "origin" "page" "all" "ALL"
Example: metaInclude=metaInclude=origin,page,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "included": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get a Label

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;attribute.id==321

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').

include
Array of strings
Items Enum: "attributes" "attribute" "ALL"
Example: include=include=attribute

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.

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Analytics Model

Get analytics model

Retrieve current analytics model of the workspace.

path Parameters
workspaceId
required
string
query Parameters
exclude
Array of strings
Items Value: "ACTIVITY_INFO"

Responses

Response samples

Content type
application/json
{
  • "analytics": {
    }
}

Set analytics model

Set effective analytics model of the workspace.

path Parameters
workspaceId
required
string
Request Body schema: application/json
object (DeclarativeAnalyticsLayer)

Responses

Request samples

Content type
application/json
{
  • "analytics": {
    }
}

Metrics

Get all Metrics

path Parameters
workspaceId
required
string
query Parameters
origin
string
Default: "ALL"
Enum: "ALL" "PARENTS" "NATIVE"

Defines scope of origin of objects. All by default.

filter
string
Example: filter=filter=title==someString;description==someString;createdBy.id==321;modifiedBy.id==321

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').

include
Array of strings
Items Enum: "userIdentifiers" "facts" "attributes" "labels" "metrics" "datasets" "createdBy" "modifiedBy" "ALL"
Example: include=include=createdBy,modifiedBy,facts,attributes,labels,metrics,datasets

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.

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "origin" "page" "all" "ALL"
Example: metaInclude=metaInclude=origin,page,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "included": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post Metrics

path Parameters
workspaceId
required
string
query Parameters
include
Array of strings
Items Enum: "userIdentifiers" "facts" "attributes" "labels" "metrics" "datasets" "createdBy" "modifiedBy" "ALL"
Example: include=include=createdBy,modifiedBy,facts,attributes,labels,metrics,datasets

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.

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiMetricPostOptionalId)

JSON:API representation of metric entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Delete a Metric

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;createdBy.id==321;modifiedBy.id==321

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').

Responses

Get a Metric

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;createdBy.id==321;modifiedBy.id==321

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').

include
Array of strings
Items Enum: "userIdentifiers" "facts" "attributes" "labels" "metrics" "datasets" "createdBy" "modifiedBy" "ALL"
Example: include=include=createdBy,modifiedBy,facts,attributes,labels,metrics,datasets

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.

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Patch a Metric

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;createdBy.id==321;modifiedBy.id==321

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').

include
Array of strings
Items Enum: "userIdentifiers" "facts" "attributes" "labels" "metrics" "datasets" "createdBy" "modifiedBy" "ALL"
Example: include=include=createdBy,modifiedBy,facts,attributes,labels,metrics,datasets

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiMetricPatch)

JSON:API representation of patching metric entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Put a Metric

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;createdBy.id==321;modifiedBy.id==321

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').

include
Array of strings
Items Enum: "userIdentifiers" "facts" "attributes" "labels" "metrics" "datasets" "createdBy" "modifiedBy" "ALL"
Example: include=include=createdBy,modifiedBy,facts,attributes,labels,metrics,datasets

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiMetricIn)

JSON:API representation of metric entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Dashboards

Get all Dashboards

path Parameters
workspaceId
required
string
query Parameters
origin
string
Default: "ALL"
Enum: "ALL" "PARENTS" "NATIVE"

Defines scope of origin of objects. All by default.

filter
string
Example: filter=filter=title==someString;description==someString;createdBy.id==321;modifiedBy.id==321

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').

include
Array of strings
Items Enum: "userIdentifiers" "visualizationObjects" "analyticalDashboards" "labels" "metrics" "datasets" "filterContexts" "dashboardPlugins" "createdBy" "modifiedBy" "ALL"
Example: include=include=createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins

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.

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "permissions" "origin" "accessInfo" "page" "all" "ALL"
Example: metaInclude=metaInclude=permissions,origin,accessInfo,page,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "included": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post Dashboards

path Parameters
workspaceId
required
string
query Parameters
include
Array of strings
Items Enum: "userIdentifiers" "visualizationObjects" "analyticalDashboards" "labels" "metrics" "datasets" "filterContexts" "dashboardPlugins" "createdBy" "modifiedBy" "ALL"
Example: include=include=createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins

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.

metaInclude
Array of strings unique
Items Enum: "permissions" "origin" "accessInfo" "all" "ALL"
Example: metaInclude=metaInclude=permissions,origin,accessInfo,all

Include Meta objects.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiAnalyticalDashboardPostOptionalId)

JSON:API representation of analyticalDashboard entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Delete a Dashboard

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;createdBy.id==321;modifiedBy.id==321

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').

Responses

Get a Dashboard

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;createdBy.id==321;modifiedBy.id==321

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').

include
Array of strings
Items Enum: "userIdentifiers" "visualizationObjects" "analyticalDashboards" "labels" "metrics" "datasets" "filterContexts" "dashboardPlugins" "createdBy" "modifiedBy" "ALL"
Example: include=include=createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins

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.

metaInclude
Array of strings unique
Items Enum: "permissions" "origin" "accessInfo" "all" "ALL"
Example: metaInclude=metaInclude=permissions,origin,accessInfo,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Patch a Dashboard

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;createdBy.id==321;modifiedBy.id==321

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').

include
Array of strings
Items Enum: "userIdentifiers" "visualizationObjects" "analyticalDashboards" "labels" "metrics" "datasets" "filterContexts" "dashboardPlugins" "createdBy" "modifiedBy" "ALL"
Example: include=include=createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiAnalyticalDashboardPatch)

JSON:API representation of patching analyticalDashboard entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Put Dashboards

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;createdBy.id==321;modifiedBy.id==321

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').

include
Array of strings
Items Enum: "userIdentifiers" "visualizationObjects" "analyticalDashboards" "labels" "metrics" "datasets" "filterContexts" "dashboardPlugins" "createdBy" "modifiedBy" "ALL"
Example: include=include=createdBy,modifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,datasets,filterContexts,dashboardPlugins

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiAnalyticalDashboardIn)

JSON:API representation of analyticalDashboard entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Context Filters

Get all Context Filters

path Parameters
workspaceId
required
string
query Parameters
origin
string
Default: "ALL"
Enum: "ALL" "PARENTS" "NATIVE"

Defines scope of origin of objects. All by default.

filter
string
Example: filter=filter=title==someString;description==someString

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').

include
Array of strings
Items Enum: "attributes" "datasets" "labels" "ALL"
Example: include=include=attributes,datasets,labels

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.

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "origin" "page" "all" "ALL"
Example: metaInclude=metaInclude=origin,page,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "included": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post Context Filters

path Parameters
workspaceId
required
string
query Parameters
include
Array of strings
Items Enum: "attributes" "datasets" "labels" "ALL"
Example: include=include=attributes,datasets,labels

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.

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiFilterContextPostOptionalId)

JSON:API representation of filterContext entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Delete a Context Filter

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString

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').

Responses

Get a Context Filter

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString

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').

include
Array of strings
Items Enum: "attributes" "datasets" "labels" "ALL"
Example: include=include=attributes,datasets,labels

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.

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Patch a Context Filter

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString

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').

include
Array of strings
Items Enum: "attributes" "datasets" "labels" "ALL"
Example: include=include=attributes,datasets,labels

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiFilterContextPatch)

JSON:API representation of patching filterContext entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Put a Context Filter

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString

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').

include
Array of strings
Items Enum: "attributes" "datasets" "labels" "ALL"
Example: include=include=attributes,datasets,labels

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiFilterContextIn)

JSON:API representation of filterContext entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Filter Views

Get all Filter views

path Parameters
workspaceId
required
string
query Parameters
origin
string
Default: "ALL"
Enum: "ALL" "PARENTS" "NATIVE"

Defines scope of origin of objects. All by default.

filter
string
Example: filter=filter=title==someString;description==someString;analyticalDashboard.id==321;user.id==321

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').

include
Array of strings
Items Enum: "analyticalDashboards" "users" "analyticalDashboard" "user" "ALL"
Example: include=include=analyticalDashboard,user

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.

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "page" "all" "ALL"
Example: metaInclude=metaInclude=page,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "included": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post Filter views

path Parameters
workspaceId
required
string
query Parameters
include
Array of strings
Items Enum: "analyticalDashboards" "users" "analyticalDashboard" "user" "ALL"
Example: include=include=analyticalDashboard,user

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiFilterViewIn)

JSON:API representation of filterView entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Delete Filter view

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;analyticalDashboard.id==321;user.id==321

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').

Responses

Get Filter view

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;analyticalDashboard.id==321;user.id==321

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').

include
Array of strings
Items Enum: "analyticalDashboards" "users" "analyticalDashboard" "user" "ALL"
Example: include=include=analyticalDashboard,user

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.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Patch Filter view

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;analyticalDashboard.id==321;user.id==321

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').

include
Array of strings
Items Enum: "analyticalDashboards" "users" "analyticalDashboard" "user" "ALL"
Example: include=include=analyticalDashboard,user

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiFilterViewPatch)

JSON:API representation of patching filterView entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Put Filter views

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;analyticalDashboard.id==321;user.id==321

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').

include
Array of strings
Items Enum: "analyticalDashboards" "users" "analyticalDashboard" "user" "ALL"
Example: include=include=analyticalDashboard,user

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiFilterViewIn)

JSON:API representation of filterView entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Get filter views

Retrieve filter views for the specific workspace

path Parameters
workspaceId
required
string
query Parameters
exclude
Array of strings
Items Value: "ACTIVITY_INFO"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set filter views

Set filter views for the specific workspace.

path Parameters
workspaceId
required
string
Request Body schema: application/json
Array
object (DeclarativeAnalyticalDashboardIdentifier)

An analytical dashboard identifier.

content
object or null (JsonNode) <= 15000 characters

Free-form JSON object

description
string <= 255 characters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$

FilterView object ID.

isDefault
boolean

Indicator whether the filter view should by applied by default.

tags
Array of strings unique
title
required
string <= 255 characters
object (DeclarativeUserIdentifier)

A user identifier.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Visualization Object

Get all Visualization Objects

path Parameters
workspaceId
required
string
query Parameters
origin
string
Default: "ALL"
Enum: "ALL" "PARENTS" "NATIVE"

Defines scope of origin of objects. All by default.

filter
string
Example: filter=filter=title==someString;description==someString;createdBy.id==321;modifiedBy.id==321

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').

include
Array of strings
Items Enum: "userIdentifiers" "facts" "attributes" "labels" "metrics" "datasets" "createdBy" "modifiedBy" "ALL"
Example: include=include=createdBy,modifiedBy,facts,attributes,labels,metrics,datasets

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.

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "origin" "page" "all" "ALL"
Example: metaInclude=metaInclude=origin,page,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "included": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post Visualization Objects

path Parameters
workspaceId
required
string
query Parameters
include
Array of strings
Items Enum: "userIdentifiers" "facts" "attributes" "labels" "metrics" "datasets" "createdBy" "modifiedBy" "ALL"
Example: include=include=createdBy,modifiedBy,facts,attributes,labels,metrics,datasets

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.

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiVisualizationObjectPostOptionalId)

JSON:API representation of visualizationObject entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Delete a Visualization Object

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;createdBy.id==321;modifiedBy.id==321

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').

Responses

Get a Visualization Object

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;createdBy.id==321;modifiedBy.id==321

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').

include
Array of strings
Items Enum: "userIdentifiers" "facts" "attributes" "labels" "metrics" "datasets" "createdBy" "modifiedBy" "ALL"
Example: include=include=createdBy,modifiedBy,facts,attributes,labels,metrics,datasets

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.

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Patch a Visualization Object

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;createdBy.id==321;modifiedBy.id==321

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').

include
Array of strings
Items Enum: "userIdentifiers" "facts" "attributes" "labels" "metrics" "datasets" "createdBy" "modifiedBy" "ALL"
Example: include=include=createdBy,modifiedBy,facts,attributes,labels,metrics,datasets

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiVisualizationObjectPatch)

JSON:API representation of patching visualizationObject entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Put a Visualization Object

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;createdBy.id==321;modifiedBy.id==321

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').

include
Array of strings
Items Enum: "userIdentifiers" "facts" "attributes" "labels" "metrics" "datasets" "createdBy" "modifiedBy" "ALL"
Example: include=include=createdBy,modifiedBy,facts,attributes,labels,metrics,datasets

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiVisualizationObjectIn)

JSON:API representation of visualizationObject entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Dependency Graph

Computes the dependent entities graph

Computes the dependent entities graph

path Parameters
workspaceId
required
string

Responses

Response samples

Content type
application/json
{
  • "graph": {
    }
}

Computes the dependent entities graph from given entry points

Computes the dependent entities graph from given entry points

path Parameters
workspaceId
required
string
Request Body schema: application/json
required
Array of objects (EntityIdentifier) [ items ]

Responses

Request samples

Content type
application/json
{
  • "identifiers": [
    ]
}

Response samples

Content type
application/json
{
  • "graph": {
    }
}

Attribute Hierarchies

Get all Attribute Hierarchies

path Parameters
workspaceId
required
string
query Parameters
origin
string
Default: "ALL"
Enum: "ALL" "PARENTS" "NATIVE"

Defines scope of origin of objects. All by default.

filter
string
Example: filter=filter=title==someString;description==someString;createdBy.id==321;modifiedBy.id==321

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').

include
Array of strings
Items Enum: "userIdentifiers" "attributes" "createdBy" "modifiedBy" "ALL"
Example: include=include=createdBy,modifiedBy,attributes

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.

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "origin" "page" "all" "ALL"
Example: metaInclude=metaInclude=origin,page,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "included": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post Attribute Hierarchies

path Parameters
workspaceId
required
string
query Parameters
include
Array of strings
Items Enum: "userIdentifiers" "attributes" "createdBy" "modifiedBy" "ALL"
Example: include=include=createdBy,modifiedBy,attributes

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.

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiAttributeHierarchyIn)

JSON:API representation of attributeHierarchy entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Delete an Attribute Hierarchy

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;createdBy.id==321;modifiedBy.id==321

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').

Responses

Get an Attribute Hierarchy

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;createdBy.id==321;modifiedBy.id==321

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').

include
Array of strings
Items Enum: "userIdentifiers" "attributes" "createdBy" "modifiedBy" "ALL"
Example: include=include=createdBy,modifiedBy,attributes

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.

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Patch an Attribute Hierarchy

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;createdBy.id==321;modifiedBy.id==321

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').

include
Array of strings
Items Enum: "userIdentifiers" "attributes" "createdBy" "modifiedBy" "ALL"
Example: include=include=createdBy,modifiedBy,attributes

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiAttributeHierarchyPatch)

JSON:API representation of patching attributeHierarchy entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Put an Attribute Hierarchy

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;createdBy.id==321;modifiedBy.id==321

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').

include
Array of strings
Items Enum: "userIdentifiers" "attributes" "createdBy" "modifiedBy" "ALL"
Example: include=include=createdBy,modifiedBy,attributes

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiAttributeHierarchyIn)

JSON:API representation of attributeHierarchy entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Usage

Info about the platform usage.

Provides information about platform usage, like amount of users, workspaces, ...

NOTE: The admin user is always excluded from this amount.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Info about the platform usage for particular items.

Provides information about platform usage, like amount of users, workspaces, ...

NOTE: The admin user is always excluded from this amount.

Request Body schema: application/json
usageItemNames
required
Array of strings unique
Items Enum: "UserCount" "WorkspaceCount"

Responses

Request samples

Content type
application/json
{
  • "usageItemNames": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Computation

(BETA) Valid descendants

(BETA) Returns map of lists of attributes that can be used as descendants of the given attributes.

path Parameters
workspaceId
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$

Workspace identifier

Request Body schema: application/json
required
Array of objects (AfmObjectIdentifierAttribute) [ items ]

List of identifiers of the attributes to get the valid descendants for.

Responses

Request samples

Content type
application/json
{
  • "attributes": [
    ]
}

Response samples

Content type
application/json
{
  • "validDescendants": {
    }
}

Valid objects

Returns list containing attributes, facts, or metrics, which can be added to given AFM while still keeping it computable.

path Parameters
workspaceId
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$

Workspace identifier

Request Body schema: application/json
required
object (AFM)

Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics.

types
required
Array of strings unique
Items Enum: "facts" "attributes" "measures"

Responses

Request samples

Content type
application/json
{
  • "afm": {
    },
  • "types": "facts"
}

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Executes analytical request and returns link to the result

AFM is a combination of attributes, measures and filters that describe a query you want to execute.

path Parameters
workspaceId
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$

Workspace identifier

header Parameters
skip-cache
boolean
Default: false

Ignore all caches during execution of current request.

timestamp
string <timestamp>
Example: 2020-06-03T10:15:30+01:00
Request Body schema: application/json
required
object (AFM)

Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics.

required
object (ResultSpec)

Specifies how the result data will be formatted (dimensions) and which additional data shall be computed (totals).

object (ExecutionSettings)

Various settings affecting the process of AFM execution or its result

Responses

Request samples

Content type
application/json
{
  • "execution": {
    },
  • "resultSpec": {
    },
  • "settings": {
    }
}

Response samples

Content type
application/json
{
  • "executionResponse": {
    }
}

Get a single execution result

Gets a single execution result.

path Parameters
workspaceId
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$

Workspace identifier

resultId
required
string
Example: a9b28f9dc55f37ea9f4a5fb0c76895923591e781

Result ID

query Parameters
offset
Array of integers <int32> [ items &lt;int32&gt; ]
Default: []
Example: offset=offset=1,10

Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.

limit
Array of integers <int32> [ items &lt;int32&gt; ]
Default: []
Example: limit=limit=1,10

Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.

excludedTotalDimensions
Array of strings
Default: []
Example: excludedTotalDimensions=excludedTotalDimensions=dim_0,dim_1

Identifiers of the dimensions where grand total data should not be returned for this request. A grand total will not be returned if all of its totalDimensions are in excludedTotalDimensions.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "dimensionHeaders": [
    ],
  • "grandTotals": [
    ],
  • "paging": {
    }
}

Get a single execution result's metadata.

The resource provides execution result's metadata as AFM and resultSpec used in execution request and an executionResponse

path Parameters
workspaceId
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$

Workspace identifier

resultId
required
string
Example: a9b28f9dc55f37ea9f4a5fb0c76895923591e781

Result ID

Responses

Response samples

Content type
application/json
{
  • "afm": {
    },
  • "executionResponse": {
    },
  • "resultSize": 0,
  • "resultSpec": {
    }
}

AFM explain resource.

The resource provides static structures needed for investigation of a problem with given AFM.

path Parameters
workspaceId
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$

Workspace identifier

query Parameters
explainType
string
Enum: "MAQL" "GRPC_MODEL" "GRPC_MODEL_SVG" "WDF" "QT" "QT_SVG" "OPT_QT" "OPT_QT_SVG" "SQL" "SETTINGS"

Requested explain type. If not specified all types are bundled in a ZIP archive.

MAQL - MAQL Abstract Syntax Tree, execution dimensions and related info

GRPC_MODEL - Datasets used in execution

GRPC_MODEL_SVG - Generated SVG image of the datasets

WDF - Workspace data filters in execution workspace context

QT - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL

QT_SVG - Generated SVG image of the Query Tree

OPT_QT - Optimized Query Tree

OPT_QT_SVG - Generated SVG image of the Optimized Query Tree

SQL - Final SQL to be executed

SETTINGS - Settings used to execute explain request

Request Body schema: application/json
required
object (AFM)

Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics.

required
object (ResultSpec)

Specifies how the result data will be formatted (dimensions) and which additional data shall be computed (totals).

object (ExecutionSettings)

Various settings affecting the process of AFM execution or its result

Responses

Request samples

Content type
application/json
{
  • "execution": {
    },
  • "resultSpec": {
    },
  • "settings": {
    }
}

Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.

Returns paged list of elements (values) of given label satisfying given filtering criteria.

path Parameters
workspaceId
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$

Workspace identifier

query Parameters
offset
integer <int32> [ 0 .. 10000 ]
Default: 0

Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.

limit
integer <int32> [ 1 .. 10000 ]
Default: 1000

Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well.

header Parameters
skip-cache
boolean
Default: false

Ignore all caches during execution of current request.

Request Body schema: application/json
cacheId
string

If specified, the element data will be taken from the result with the same cacheId if it is available.

complementFilter
boolean
Default: false

Inverse filters:

  • false - return items matching patternFilter and exactFilter
  • true - return items not matching patternFilter and exactFilter
dataSamplingPercentage
number <float>
Deprecated
Default: 100

Specifies percentage of source table data scanned during the computation. This field is deprecated and is no longer used during the elements computation.

Array of (DependsOn (object or null)) or (DependsOnDateFilter (object or null))[ items ]

Return only items that are not filtered-out by the parent filters.

exactFilter
Array of strings or null[ items ]

Return only items, whose label title exactly matches one of filter.

excludePrimaryLabel
boolean
Default: false

Excludes items from the result that differ only by primary label

  • false - return items with distinct primary label
  • true - return items with distinct requested label
object (FilterBy)

Specifies what is used for filtering.

label
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$

Requested label.

patternFilter
string

Return only items, whose label title case insensitively contains filter as substring.

sortOrder
string
Enum: "ASC" "DESC"

Sort order of returned items. Items are sorted by label title. If no sort order is specified then attribute's sortDirection is used, which is ASC by default

Array of objects or null (ValidateByItem) [ items ]

Return only items that are computable on metric.

Responses

Request samples

Content type
application/json
{
  • "cacheId": "string",
  • "complementFilter": false,
  • "dataSamplingPercentage": 100,
  • "dependsOn": [
    ],
  • "exactFilter": [
    ],
  • "excludePrimaryLabel": false,
  • "filterBy": {
    },
  • "label": "label_id",
  • "patternFilter": "string",
  • "sortOrder": "ASC",
  • "validateBy": [
    ]
}

Response samples

Content type
application/json
{}

(EXPERIMENTAL) Compute key driver analysis

(EXPERIMENTAL) Computes key driver analysis for the provided execution definition.

path Parameters
workspaceId
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$

Workspace identifier

header Parameters
skip-cache
boolean
Default: false

Ignore all caches during execution of current request.

Request Body schema: application/json
Array of objects (MeasureItem) [ items ]

Additional metrics to be included in the computation, but excluded from the analysis.

required
object (MeasureItem)

Metric is a quantity that is calculated from the data.

sortDirection
string
Default: "DESC"
Enum: "ASC" "DESC"

Sorting elements - ascending/descending order.

Responses

Request samples

Content type
application/json
{
  • "auxMetrics": [
    ],
  • "metric": {
    },
  • "sortDirection": "ASC"
}

Response samples

Content type
application/json
{
  • "dimensions": [
    ],
  • "links": {
    }
}

(EXPERIMENTAL) Get key driver analysis result

(EXPERIMENTAL) Gets key driver analysis.

path Parameters
workspaceId
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$

Workspace identifier

resultId
required
string
Example: a9b28f9dc55f37ea9f4a5fb0c76895923591e781

Result ID

query Parameters
offset
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": { }
}

Smart Functions

(BETA) Chat with AI

(BETA) Combines multiple use cases such as search, create visualizations, ...

path Parameters
workspaceId
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$

Workspace identifier

Request Body schema: application/json
limitCreate
integer <int32>
Default: 3

Maximum number of created results.

limitCreateContext
integer <int32>
Default: 10

Maximum number of relevant objects included into context for LLM (for each object type).

limitSearch
integer <int32>
Default: 5

Maximum number of search results.

question
required
string <= 2000 characters

User question

relevantScoreThreshold
number <double>
Default: 0.45

Score, above which we return found objects. Below this score objects are not relevant.

searchScoreThreshold
number <double>
Default: 0.9

Score, above which we return found object(s) and don't call LLM to create new objects.

threadIdSuffix
string

Chat History thread suffix appended to ID generated by backend. Enables more chat windows.

titleToDescriptorRatio
number <double>
Default: 0.7

Temporary for experiments. Ratio of title score to descriptor score.

object (UserContext)

User context, which can affect the behavior of the underlying AI features.

Responses

Request samples

Content type
application/json
{
  • "limitCreate": 3,
  • "limitCreateContext": 10,
  • "limitSearch": 5,
  • "question": "string",
  • "relevantScoreThreshold": 0.45,
  • "searchScoreThreshold": 0.9,
  • "threadIdSuffix": "string",
  • "titleToDescriptorRatio": 0.7,
  • "userContext": {
    }
}

Response samples

Content type
application/json
{
  • "chatHistoryInteractionId": "string",
  • "createdVisualizations": {
    },
  • "errorResponse": "string",
  • "foundObjects": {
    },
  • "routing": {
    },
  • "textResponse": "string",
  • "threadIdSuffix": "string"
}

(BETA) Get Chat History

(BETA) Post thread ID (and optionally interaction ID) to get full/partial chat history.

path Parameters
workspaceId
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$

Workspace identifier

Request Body schema: application/json
chatHistoryInteractionId
string

Return chat history records only after this interaction ID. If empty, complete chat history is returned.

reset
boolean

User feedback.

threadIdSuffix
string

Chat History thread suffix appended to ID generated by backend. Enables more chat windows.

userFeedback
string
Enum: "POSITIVE" "NEGATIVE" "NONE"

User feedback.

Responses

Request samples

Content type
application/json
{
  • "chatHistoryInteractionId": "string",
  • "reset": true,
  • "threadIdSuffix": "string",
  • "userFeedback": "POSITIVE"
}

Response samples

Content type
application/json
{
  • "interactions": [
    ],
  • "threadId": "string"
}

(BETA) Chat with AI

(BETA) Combines multiple use cases such as search, create visualizations, ...

path Parameters
workspaceId
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$

Workspace identifier

Request Body schema: application/json
limitCreate
integer <int32>
Default: 3

Maximum number of created results.

limitCreateContext
integer <int32>
Default: 10

Maximum number of relevant objects included into context for LLM (for each object type).

limitSearch
integer <int32>
Default: 5

Maximum number of search results.

question
required
string <= 2000 characters

User question

relevantScoreThreshold
number <double>
Default: 0.45

Score, above which we return found objects. Below this score objects are not relevant.

searchScoreThreshold
number <double>
Default: 0.9

Score, above which we return found object(s) and don't call LLM to create new objects.

threadIdSuffix
string

Chat History thread suffix appended to ID generated by backend. Enables more chat windows.

titleToDescriptorRatio
number <double>
Default: 0.7

Temporary for experiments. Ratio of title score to descriptor score.

object (UserContext)

User context, which can affect the behavior of the underlying AI features.

Responses

Request samples

Content type
application/json
{
  • "limitCreate": 3,
  • "limitCreateContext": 10,
  • "limitSearch": 5,
  • "question": "string",
  • "relevantScoreThreshold": 0.45,
  • "searchScoreThreshold": 0.9,
  • "threadIdSuffix": "string",
  • "titleToDescriptorRatio": 0.7,
  • "userContext": {
    }
}

(BETA) Semantic Search in Metadata

(BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects.

path Parameters
workspaceId
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$

Workspace identifier

Request Body schema: application/json
deepSearch
boolean
Default: false

Turn on deep search. If true, content of complex objects will be searched as well, e.g. metrics in visualizations.

limit
integer <int32>
Default: 10

Maximum number of results to return. There is a hard limit and the actual number of returned results may be lower than what is requested.

objectTypes
Array of strings
Items Enum: "attribute" "metric" "fact" "label" "date" "dataset" "visualization" "dashboard"

List of object types to search for.

question
required
string <= 1000 characters

Keyword/sentence is input for search.

relevantScoreThreshold
number <double>
Default: 0.3

Score, above which we return found objects. Below this score objects are not relevant.

titleToDescriptorRatio
number <double>
Default: 0.7

Temporary for experiments. Ratio of title score to descriptor score.

Responses

Request samples

Content type
application/json
{
  • "deepSearch": false,
  • "limit": 10,
  • "objectTypes": [
    ],
  • "question": "string",
  • "relevantScoreThreshold": 0.3,
  • "titleToDescriptorRatio": 0.7
}

Response samples

Content type
application/json
{
  • "reasoning": "string",
  • "relationships": [
    ],
  • "results": [
    ]
}

(EXPERIMENTAL) Smart functions - Anomaly Detection Result

(EXPERIMENTAL) Gets anomalies.

path Parameters
workspaceId
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$

Workspace identifier

resultId
required
string
Example: a9b28f9dc55f37ea9f4a5fb0c76895923591e781

Result ID

query Parameters
offset
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "anomalyFlag": [
    ],
  • "attribute": [
    ],
  • "values": [
    ]
}

(EXPERIMENTAL) Smart functions - Anomaly Detection

(EXPERIMENTAL) Computes anomaly detection.

path Parameters
workspaceId
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$

Workspace identifier

resultId
required
string
Example: 9bd52018570364264fcf62d373da6bed313120e8

Input result ID to be used in the computation

header Parameters
skip-cache
boolean
Default: false

Ignore all caches during execution of current request.

Request Body schema: application/json
sensitivity
required
number <float>

Anomaly detection sensitivity.

Responses

Request samples

Content type
application/json
{
  • "sensitivity": 0
}

Response samples

Content type
application/json
{
  • "links": {
    }
}

(EXPERIMENTAL) Smart functions - Clustering Result

(EXPERIMENTAL) Gets clustering result.

path Parameters
workspaceId
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$

Workspace identifier

resultId
required
string
Example: a9b28f9dc55f37ea9f4a5fb0c76895923591e781

Result ID

query Parameters
offset
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "attribute": [
    ],
  • "clusters": [
    ],
  • "xcoord": [
    ],
  • "ycoord": [
    ]
}

(EXPERIMENTAL) Smart functions - Clustering

(EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.

path Parameters
workspaceId
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$

Workspace identifier

resultId
required
string
Example: 9bd52018570364264fcf62d373da6bed313120e8

Input result ID to be used in the computation

header Parameters
skip-cache
boolean
Default: false

Ignore all caches during execution of current request.

Request Body schema: application/json
numberOfClusters
required
integer <int32> >= 1

Number of clusters to create

threshold
number <double> > 0
Default: 0.03

Threshold used for algorithm

Responses

Request samples

Content type
application/json
{
  • "numberOfClusters": 1,
  • "threshold": 0.03
}

Response samples

Content type
application/json
{
  • "links": {
    }
}

(BETA) Smart functions - Forecast Result

(BETA) Gets forecast result.

path Parameters
workspaceId
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$

Workspace identifier

resultId
required
string
Example: a9b28f9dc55f37ea9f4a5fb0c76895923591e781

Result ID

query Parameters
offset
integer <int32>
limit
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "attribute": [
    ],
  • "lowerBound": [
    ],
  • "origin": [
    ],
  • "prediction": [
    ],
  • "upperBound": [
    ]
}

(BETA) Smart functions - Forecast

(BETA) Computes forecasted data points from the provided execution result and parameters.

path Parameters
workspaceId
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$

Workspace identifier

resultId
required
string
Example: 9bd52018570364264fcf62d373da6bed313120e8

Input result ID to be used in the computation

header Parameters
skip-cache
boolean
Default: false

Ignore all caches during execution of current request.

Request Body schema: application/json
confidenceLevel
number <float> ( 0 .. 1 )
Default: 0.95

Confidence interval boundary value.

forecastPeriod
required
integer <int32>

Number of future periods that should be forecasted

seasonal
boolean
Default: false

Whether the input data is seasonal

Responses

Request samples

Content type
application/json
{
  • "confidenceLevel": 0.95,
  • "forecastPeriod": 0,
  • "seasonal": false
}

Response samples

Content type
application/json
{
  • "links": {
    }
}

Entitlement

Values for all public entitlements.

Resolves values of available entitlements for the organization.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Values for requested public entitlements.

Resolves values for requested entitlements in the organization.

Request Body schema: application/json
entitlementsName
required
Array of strings unique
Items Enum: "CacheStrategy" "Contract" "CustomTheming" "ExtraCache" "Hipaa" "PdfExports" "ManagedOIDC" "UiLocalization" "Tier" "UserCount" "UnlimitedUsers" "UnlimitedWorkspaces" "WhiteLabeling" "WorkspaceCount" "UserTelemetryDisabled" "AutomationCount" "UnlimitedAutomations" "AutomationRecipientCount" "UnlimitedAutomationRecipients" "DailyScheduledActionCount" "UnlimitedDailyScheduledActions" "DailyAlertActionCount" "UnlimitedDailyAlertActions" "ScheduledActionMinimumRecurrenceMinutes" "FederatedIdentityManagement"

Responses

Request samples

Content type
application/json
{
  • "entitlementsName": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Entitlements

Space of the shared interest

query Parameters
filter
string
Example: filter=filter=value==someString;expiry==LocalDateValue

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').

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "page" "all" "ALL"
Example: metaInclude=metaInclude=page,all

Include Meta objects.

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get Entitlement

Space of the shared interest

path Parameters
id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
query Parameters
filter
string
Example: filter=filter=value==someString;expiry==LocalDateValue

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').

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "links": {}
}

Reporting - Settings

Values for all settings without workspace.

Resolves values for all settings without workspace by current user, organization, or default settings.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Values for selected settings without workspace.

Resolves values for selected settings without workspace by current user, organization, or default settings.

Request Body schema: application/json
settings
required
Array of strings

An array of setting IDs to resolve.

Responses

Request samples

Content type
application/json
{
  • "settings": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Cache usage

Collect data about the current cache usage

Get the detailed data about how much cache your organization is currently using, broken down by individual workspaces.

Responses

Response samples

Content type
application/json
{
  • "organizationCacheUsage": {
    },
  • "workspaceCacheUsages": {
    }
}

Automations

Get all Automations

path Parameters
workspaceId
required
string
query Parameters
origin
string
Default: "ALL"
Enum: "ALL" "PARENTS" "NATIVE"

Defines scope of origin of objects. All by default.

filter
string
Example: filter=filter=title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321

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').

include
Array of strings
Items Enum: "notificationChannels" "analyticalDashboards" "userIdentifiers" "exportDefinitions" "users" "notificationChannel" "analyticalDashboard" "createdBy" "modifiedBy" "recipients" "ALL"
Example: include=include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients

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.

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "origin" "page" "all" "ALL"
Example: metaInclude=metaInclude=origin,page,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "included": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post Automations

path Parameters
workspaceId
required
string
query Parameters
include
Array of strings
Items Enum: "notificationChannels" "analyticalDashboards" "userIdentifiers" "exportDefinitions" "users" "notificationChannel" "analyticalDashboard" "createdBy" "modifiedBy" "recipients" "ALL"
Example: include=include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients

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.

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiAutomationIn)

JSON:API representation of automation entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Delete an Automation

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321

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').

Responses

Get an Automation

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321

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').

include
Array of strings
Items Enum: "notificationChannels" "analyticalDashboards" "userIdentifiers" "exportDefinitions" "users" "notificationChannel" "analyticalDashboard" "createdBy" "modifiedBy" "recipients" "ALL"
Example: include=include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients

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.

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Patch an Automation

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321

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').

include
Array of strings
Items Enum: "notificationChannels" "analyticalDashboards" "userIdentifiers" "exportDefinitions" "users" "notificationChannel" "analyticalDashboard" "createdBy" "modifiedBy" "recipients" "ALL"
Example: include=include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiAutomationPatch)

JSON:API representation of patching automation entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Put an Automation

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321

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').

include
Array of strings
Items Enum: "notificationChannels" "analyticalDashboards" "userIdentifiers" "exportDefinitions" "users" "notificationChannel" "analyticalDashboard" "createdBy" "modifiedBy" "recipients" "ALL"
Example: include=include=notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiAutomationIn)

JSON:API representation of automation entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Get automations

Retrieve automations for the specific workspace

path Parameters
workspaceId
required
string
query Parameters
exclude
Array of strings
Items Value: "ACTIVITY_INFO"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Set automations

Set automations for the specific workspace.

path Parameters
workspaceId
required
string
Request Body schema: application/json
Array
object (AutomationAlert)
object (DeclarativeAnalyticalDashboardIdentifier)

An analytical dashboard identifier.

createdAt
string or null[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}

Time of the entity creation.

object (DeclarativeUserIdentifier)

A user identifier.

description
string <= 255 characters
object <= 10000 characters

TODO

Array of objects (DeclarativeExportDefinitionIdentifier) unique [ items ]
Array of objects (AutomationExternalRecipient) unique [ items ]

External recipients of the automation action results.

id
required
string^(?!\.)[.A-Za-z0-9_-]{1,255}$
metadata
object or null (JsonNode) <= 15000 characters

Free-form JSON object

modifiedAt
string or null[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}

Time of the last entity modification.

object (DeclarativeUserIdentifier)

A user identifier.

object (DeclarativeNotificationChannelIdentifier)

A notification channel identifier.

Array of objects (DeclarativeUserIdentifier) unique [ items ]
object (AutomationSchedule)
state
string
Default: "ACTIVE"
Enum: "ACTIVE" "PAUSED"

Current state of the automation.

Array of objects (AutomationTabularExport) unique [ items ]
tags
Array of strings unique
title
string <= 255 characters
Array of objects (AutomationVisualExport) unique [ items ]

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Tabular export

(EXPERIMENTAL) Create dashboard tabular export request

Note: This API is an experimental and is going to change. Please, use it accordingly.An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.

path Parameters
workspaceId
required
string
dashboardId
required
string

Responses

Response samples

Content type
application/json
{
  • "exportResult": "string"
}

Create tabular export request

An tabular export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.

path Parameters
workspaceId
required
string
Request Body schema: application/json
object (CustomOverride)

Custom cell value overrides (IDs will be replaced with specified values).

executionResult
string

Execution result identifier.

fileName
required
string

Filename of downloaded file without extension.

format
required
string
Enum: "CSV" "XLSX" "HTML" "PDF"

Expected file format.

metadata
object or null (JsonNode) <= 15000 characters

Free-form JSON object

relatedDashboardId
string

Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.

object (Settings)

Additional settings.

visualizationObject
string

Visualization object identifier. Alternative to executionResult property.

visualizationObjectCustomFilters
Array of objects[ items ]

Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given.

Responses

Request samples

Content type
application/json
{
  • "customOverride": {
    },
  • "executionResult": "ff483727196c9dc862c7fd3a5a84df55c96d61a4",
  • "fileName": "result",
  • "format": "CSV",
  • "metadata": { },
  • "relatedDashboardId": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0",
  • "settings": {
    },
  • "visualizationObject": "f7c359bc-c230-4487-b15b-ad9685bcb537",
  • "visualizationObjectCustomFilters": "[{\"negativeAttributeFilter\":{\"displayForm\":{\"identifier\":{\"id\":\"products.category\",\"type\":\"label\"}},\"notIn\":{\"values\":[\"Books\"]}}}]"
}

Response samples

Content type
application/json
{
  • "exportResult": "string"
}

Retrieve exported files

After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn't ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.

path Parameters
workspaceId
required
string
exportId
required
string

Responses

Visual export

Create visual - pdf export request

An visual export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.

path Parameters
workspaceId
required
string
Request Body schema: application/json
dashboardId
required
string

Dashboard identifier

fileName
required
string

File name to be used for retrieving the pdf document.

metadata
object

Metadata definition in free-form JSON format.

Responses

Request samples

Content type
application/json
{
  • "dashboardId": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0",
  • "fileName": "filename",
  • "metadata": "{}"
}

Response samples

Content type
application/json
{
  • "exportResult": "string"
}

Retrieve exported files

Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.

path Parameters
workspaceId
required
string
exportId
required
string

Responses

Retrieve metadata context

This endpoints serves as a cache for user defined metadata for the front end ui to retrieve them, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified. If metadata for given {exportId} has been found, endpoint returns the value 200 else 404.

path Parameters
workspaceId
required
string
exportId
required
string

Responses

Export Definitions

Get all Export Definitions

path Parameters
workspaceId
required
string
query Parameters
origin
string
Default: "ALL"
Enum: "ALL" "PARENTS" "NATIVE"

Defines scope of origin of objects. All by default.

filter
string
Example: filter=filter=title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321

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').

include
Array of strings
Items Enum: "visualizationObjects" "analyticalDashboards" "automations" "userIdentifiers" "visualizationObject" "analyticalDashboard" "automation" "createdBy" "modifiedBy" "ALL"
Example: include=include=visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy

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.

page
integer
Default: 0

Zero-based page index (0..N)

size
integer
Default: 20

The size of the page to be returned

sort
Array of strings

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

metaInclude
Array of strings unique
Items Enum: "origin" "page" "all" "ALL"
Example: metaInclude=metaInclude=origin,page,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": [
    ],
  • "included": [
    ],
  • "links": {},
  • "meta": {
    }
}

Post Export Definitions

path Parameters
workspaceId
required
string
query Parameters
include
Array of strings
Items Enum: "visualizationObjects" "analyticalDashboards" "automations" "userIdentifiers" "visualizationObject" "analyticalDashboard" "automation" "createdBy" "modifiedBy" "ALL"
Example: include=include=visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy

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.

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiExportDefinitionPostOptionalId)

JSON:API representation of exportDefinition entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Delete an Export Definition

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321

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').

Responses

Get an Export Definition

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321

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').

include
Array of strings
Items Enum: "visualizationObjects" "analyticalDashboards" "automations" "userIdentifiers" "visualizationObject" "analyticalDashboard" "automation" "createdBy" "modifiedBy" "ALL"
Example: include=include=visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy

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.

metaInclude
Array of strings unique
Items Enum: "origin" "all" "ALL"
Example: metaInclude=metaInclude=origin,all

Include Meta objects.

header Parameters
X-GDC-VALIDATE-RELATIONS
boolean
Default: false

Responses

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Patch an Export Definition

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321

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').

include
Array of strings
Items Enum: "visualizationObjects" "analyticalDashboards" "automations" "userIdentifiers" "visualizationObject" "analyticalDashboard" "automation" "createdBy" "modifiedBy" "ALL"
Example: include=include=visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiExportDefinitionPatch)

JSON:API representation of patching exportDefinition entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}

Put an Export Definition

path Parameters
workspaceId
required
string
objectId
required
string
query Parameters
filter
string
Example: filter=filter=title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321

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').

include
Array of strings
Items Enum: "visualizationObjects" "analyticalDashboards" "automations" "userIdentifiers" "visualizationObject" "analyticalDashboard" "automation" "createdBy" "modifiedBy" "ALL"
Example: include=include=visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy

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.

Request Body schema: application/vnd.gooddata.api+json
required
object (JsonApiExportDefinitionIn)

JSON:API representation of exportDefinition entity.

Responses

Request samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.gooddata.api+json
{
  • "data": {
    },
  • "included": [
    ],
  • "links": {}
}