{ "components": { "parameters": { "idPathParameter": { "in": "path", "name": "id", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, "page": { "description": "Zero-based page index (0..N)", "in": "query", "name": "page", "schema": { "default": 0, "type": "integer" } }, "size": { "description": "The size of the page to be returned", "in": "query", "name": "size", "schema": { "default": 20, "type": "integer" } }, "sort": { "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", "in": "query", "name": "sort", "schema": { "items": { "type": "string" }, "type": "array" } } }, "responses": { "Deleted": { "description": "Successfully deleted" } }, "schemas": { "AFM": { "description": "Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics.", "properties": { "attributes": { "description": "Attributes to be used in the computation.", "items": { "$ref": "#/components/schemas/AttributeItem" }, "type": "array" }, "auxMeasures": { "description": "Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.", "items": { "$ref": "#/components/schemas/MeasureItem" }, "type": "array" }, "filters": { "description": "Various filter types to filter execution result.", "items": { "$ref": "#/components/schemas/FilterDefinition" }, "type": "array" }, "measures": { "description": "Metrics to be computed.", "items": { "$ref": "#/components/schemas/MeasureItem" }, "type": "array" } }, "required": [ "attributes", "filters", "measures" ], "type": "object" }, "AbsoluteDateFilter": { "description": "A datetime filter specifying exact from and to values.", "properties": { "absoluteDateFilter": { "properties": { "applyOnResult": { "type": "boolean" }, "dataset": { "$ref": "#/components/schemas/AfmObjectIdentifierDataset" }, "from": { "example": "2020-07-01 18:23", "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", "type": "string" }, "to": { "example": "2020-07-16 23:59", "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", "type": "string" } }, "required": [ "from", "to", "dataset" ], "type": "object" } }, "required": [ "absoluteDateFilter" ], "type": "object" }, "AbstractMeasureValueFilter": { "oneOf": [ { "$ref": "#/components/schemas/ComparisonMeasureValueFilter" }, { "$ref": "#/components/schemas/RangeMeasureValueFilter" }, { "$ref": "#/components/schemas/RankingFilter" } ], "type": "object" }, "AfmExecution": { "properties": { "execution": { "$ref": "#/components/schemas/AFM" }, "resultSpec": { "$ref": "#/components/schemas/ResultSpec" }, "settings": { "$ref": "#/components/schemas/ExecutionSettings" } }, "required": [ "execution", "resultSpec" ], "type": "object" }, "AfmExecutionResponse": { "properties": { "executionResponse": { "$ref": "#/components/schemas/ExecutionResponse" } }, "required": [ "executionResponse" ], "type": "object" }, "AfmIdentifier": { "oneOf": [ { "$ref": "#/components/schemas/AfmObjectIdentifier" }, { "$ref": "#/components/schemas/AfmLocalIdentifier" } ], "type": "object" }, "AfmLocalIdentifier": { "properties": { "localIdentifier": { "example": "sampleAutoGenerated0123_ID", "pattern": "^[.a-zA-Z0-9_-]+$", "type": "string" } }, "required": [ "localIdentifier" ], "type": "object" }, "AfmObjectIdentifier": { "description": "ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers.", "properties": { "identifier": { "properties": { "id": { "example": "sample_item.price", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "enum": [ "analyticalDashboard", "attribute", "dashboardPlugin", "dataset", "fact", "label", "metric", "prompt", "visualizationObject", "filterContext" ], "example": "fact", "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "required": [ "identifier" ], "type": "object" }, "AfmObjectIdentifierAttribute": { "properties": { "identifier": { "properties": { "id": { "example": "sample_item.price", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "enum": [ "attribute" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" } }, "required": [ "identifier" ], "type": "object" }, "AfmObjectIdentifierCore": { "properties": { "identifier": { "properties": { "id": { "example": "sample_item.price", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "enum": [ "attribute", "label", "fact", "metric" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" } }, "required": [ "identifier" ], "type": "object" }, "AfmObjectIdentifierDataset": { "properties": { "identifier": { "properties": { "id": { "example": "sample_item.price", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "enum": [ "dataset" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" } }, "required": [ "identifier" ], "type": "object" }, "AfmObjectIdentifierLabel": { "properties": { "identifier": { "properties": { "id": { "example": "sample_item.price", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "enum": [ "label" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" } }, "required": [ "identifier" ], "type": "object" }, "AfmValidDescendantsQuery": { "description": "Entity describing the valid descendants request.", "properties": { "attributes": { "description": "List of identifiers of the attributes to get the valid descendants for.", "items": { "$ref": "#/components/schemas/AfmObjectIdentifierAttribute" }, "type": "array" } }, "required": [ "attributes" ], "type": "object" }, "AfmValidDescendantsResponse": { "description": "Entity describing the valid descendants response.", "properties": { "validDescendants": { "additionalProperties": { "description": "Map of attribute identifiers to list of valid descendants identifiers.", "items": { "$ref": "#/components/schemas/AfmObjectIdentifierAttribute" }, "type": "array" }, "description": "Map of attribute identifiers to list of valid descendants identifiers.", "type": "object" } }, "required": [ "validDescendants" ], "type": "object" }, "AfmValidObjectsQuery": { "description": "Entity holding AFM and list of object types whose validity should be computed.", "properties": { "afm": { "$ref": "#/components/schemas/AFM" }, "types": { "example": "facts", "items": { "enum": [ "facts", "attributes", "measures" ], "example": "facts", "type": "string" }, "type": "array", "uniqueItems": true } }, "required": [ "afm", "types" ], "type": "object" }, "AfmValidObjectsResponse": { "description": "All objects of specified types valid with respect to given AFM.", "properties": { "items": { "items": { "$ref": "#/components/schemas/RestApiIdentifier" }, "type": "array" } }, "required": [ "items" ], "type": "object" }, "AnalyzeCsvRequest": { "description": "Bulk CSV analysis request.", "properties": { "analyzeRequests": { "description": "List of individual CSV analysis requests.", "items": { "$ref": "#/components/schemas/AnalyzeCsvRequestItem" }, "type": "array" } }, "required": [ "analyzeRequests" ], "type": "object" }, "AnalyzeCsvRequestItem": { "description": "CSV analysis request.", "properties": { "config": { "$ref": "#/components/schemas/AnalyzeCsvRequestItemConfig" }, "location": { "description": "Location of the CSV file to analyze.", "type": "string" } }, "required": [ "location" ], "type": "object" }, "AnalyzeCsvRequestItemConfig": { "description": "CSV analysis request config.", "properties": { "delimiters": { "description": "Possible column delimiters.", "items": { "description": "Possible column delimiters.", "type": "string" }, "type": "array" }, "headerDetectMaxRows": { "description": "Maximum number of rows to work with during header detection.", "format": "int32", "type": "integer" }, "resultRows": { "description": "Number of rows to return in the flight that represents analysis result. If 0, no rows are returned, if less than 0, all rows that were in the sample are returned.", "format": "int32", "type": "integer" } }, "type": "object" }, "AnalyzeCsvResponse": { "description": "Describes the results of a CSV analysis of a single file.", "properties": { "columns": { "description": "List of column metadata.", "items": { "$ref": "#/components/schemas/AnalyzeCsvResponseColumn" }, "type": "array" }, "config": { "$ref": "#/components/schemas/AnalyzeCsvResponseConfig" }, "location": { "description": "Location of the analyzed file in the source data source.", "type": "string" }, "previewData": { "description": "Preview of the first N rows of the file.", "items": { "description": "Preview of the first N rows of the file.", "items": { "description": "Preview of the first N rows of the file.", "type": "object" }, "type": "array" }, "type": "array" } }, "required": [ "columns", "location", "previewData" ], "type": "object" }, "AnalyzeCsvResponseColumn": { "description": "Describes the result column.", "properties": { "detectedDateFormats": { "description": "List of date formats that can be used to parse this column as date. Null if there are none.", "items": { "description": "List of date formats that can be used to parse this column as date. Null if there are none.", "type": "string" }, "type": "array" }, "name": { "description": "Name of the column as specified in the file (or autogenerated one if the file has no header).", "type": "string" }, "type": { "description": "Type of the column (e.g. string, bool, etc.).", "type": "string" } }, "required": [ "name", "type" ], "type": "object" }, "AnalyzeCsvResponseConfig": { "description": "Config used to process the CSV file.", "properties": { "convertOptions": { "$ref": "#/components/schemas/CsvConvertOptions" }, "parseOptions": { "$ref": "#/components/schemas/CsvParseOptions" }, "readOptions": { "$ref": "#/components/schemas/CsvReadOptions" } }, "type": "object" }, "ApiEntitlement": { "description": "Defines entitlements for given organization.", "properties": { "expiry": { "format": "date", "type": "string" }, "name": { "enum": [ "CacheStrategy", "Contract", "CustomTheming", "ExtraCache", "Hipaa", "PdfExports", "ManagedOIDC", "UiLocalization", "Tier", "UserCount", "UnlimitedUsers", "UnlimitedWorkspaces", "WhiteLabeling", "WorkspaceCount", "UserTelemetryDisabled" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ArithmeticMeasureDefinition": { "description": "Metric representing arithmetics between metrics.", "properties": { "arithmeticMeasure": { "properties": { "measureIdentifiers": { "description": "List of metrics to apply arithmetic operation by chosen operator.", "items": { "$ref": "#/components/schemas/AfmLocalIdentifier" }, "type": "array" }, "operator": { "description": "Arithmetic operator describing operation between metrics.", "enum": [ "SUM", "DIFFERENCE", "MULTIPLICATION", "RATIO", "CHANGE" ], "example": "SUM", "type": "string" } }, "required": [ "measureIdentifiers", "operator" ], "type": "object" } }, "required": [ "arithmeticMeasure" ], "type": "object" }, "AssigneeIdentifier": { "description": "Identifier of a user or user-group.", "properties": { "id": { "type": "string" }, "type": { "enum": [ "user", "userGroup" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "AssigneeRule": { "description": "Identifier of an assignee rule.", "properties": { "type": { "enum": [ "allWorkspaceUsers" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "AttributeExecutionResultHeader": { "properties": { "attributeHeader": { "$ref": "#/components/schemas/AttributeResultHeader" } }, "required": [ "attributeHeader" ], "type": "object" }, "AttributeFilter": { "description": "Abstract filter definition type attributes", "oneOf": [ { "$ref": "#/components/schemas/NegativeAttributeFilter" }, { "$ref": "#/components/schemas/PositiveAttributeFilter" } ], "type": "object" }, "AttributeFilterElements": { "description": "Filter on specific set of label values.", "properties": { "values": { "description": "Set of label values.", "example": [ "value1", "value2" ], "items": { "nullable": true, "type": "string" }, "type": "array", "uniqueItems": true } }, "required": [ "values" ], "type": "object" }, "AttributeFormat": { "properties": { "locale": { "description": "Format locale", "type": "string" }, "pattern": { "description": "Format pattern", "type": "string" } }, "required": [ "locale", "pattern" ], "type": "object" }, "AttributeHeaderOut": { "properties": { "attributeHeader": { "properties": { "attribute": { "$ref": "#/components/schemas/RestApiIdentifier" }, "attributeName": { "type": "string" }, "format": { "$ref": "#/components/schemas/AttributeFormat" }, "granularity": { "enum": [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR" ], "type": "string" }, "label": { "$ref": "#/components/schemas/RestApiIdentifier" }, "labelName": { "type": "string" }, "localIdentifier": { "pattern": "^[.a-zA-Z0-9_-]+$", "type": "string" }, "primaryLabel": { "$ref": "#/components/schemas/RestApiIdentifier" } }, "required": [ "attribute", "attributeName", "label", "labelName", "localIdentifier", "primaryLabel" ], "type": "object" } }, "required": [ "attributeHeader" ], "type": "object" }, "AttributeItem": { "properties": { "label": { "$ref": "#/components/schemas/AfmObjectIdentifierLabel" }, "localIdentifier": { "pattern": "^[.a-zA-Z0-9_-]+$", "type": "string" }, "showAllValues": { "default": false, "description": "Specifies that the label should be outer-joined.", "type": "boolean" } }, "required": [ "label", "localIdentifier" ], "type": "object" }, "AttributeResultHeader": { "description": "Header containing the information related to attributes.", "properties": { "labelValue": { "description": "A value of the current attribute label.", "example": "East Coast", "type": "string" }, "primaryLabelValue": { "description": "A value of the primary attribute label.", "example": "1225", "type": "string" } }, "required": [ "labelValue", "primaryLabelValue" ], "type": "object" }, "AuthUser": { "description": "Entity representing user in authentication system.", "properties": { "authenticationId": { "description": "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).", "type": "string" }, "displayName": { "description": "User description, which will be visible in application.", "example": "jeremy", "type": "string" }, "email": { "description": "Email - used as lookup (must be unique). For PUT method, it must be same as in URL", "example": "zeus@example.com", "type": "string" }, "password": { "description": "User password. It is not returned by GET method.", "type": "string" } }, "required": [ "displayName", "email" ], "type": "object" }, "AvailableAssignees": { "properties": { "userGroups": { "description": "List of user groups", "items": { "$ref": "#/components/schemas/UserGroupAssignee" }, "type": "array" }, "users": { "description": "List of users", "items": { "$ref": "#/components/schemas/UserAssignee" }, "type": "array" } }, "required": [ "userGroups", "users" ], "type": "object" }, "CacheRemovalInterval": { "description": "Information about a period in time and how much cached data was removed.", "properties": { "from": { "description": "Start timestamp of the removal interval.", "format": "date-time", "type": "string" }, "removed": { "description": "Bytes removed during this interval.", "format": "int64", "type": "integer" }, "to": { "description": "End timestamp of the removal interval.", "format": "date-time", "type": "string" } }, "required": [ "from", "removed", "to" ], "type": "object" }, "CacheUsageData": { "description": "Result of scan of data source physical model.", "properties": { "organizationCacheUsage": { "$ref": "#/components/schemas/OrganizationCacheUsage" }, "workspaceCacheUsages": { "additionalProperties": { "$ref": "#/components/schemas/WorkspaceCacheUsage" }, "description": "Map of data about the cache usage of the individual workspaces.", "type": "object" } }, "required": [ "organizationCacheUsage", "workspaceCacheUsages" ], "type": "object" }, "ColumnWarning": { "description": "Warning related to single column.", "properties": { "message": { "description": "Warning message related to the column.", "type": "string" }, "name": { "description": "Column name.", "type": "string" } }, "required": [ "message", "name" ], "type": "object" }, "ComparisonMeasureValueFilter": { "description": "Filter the result by comparing specified metric to given constant value, using given comparison operator.", "properties": { "comparisonMeasureValueFilter": { "properties": { "applyOnResult": { "type": "boolean" }, "measure": { "$ref": "#/components/schemas/AfmIdentifier" }, "operator": { "enum": [ "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO" ], "example": "GREATER_THAN", "type": "string" }, "treatNullValuesAs": { "example": 0, "type": "number" }, "value": { "example": 1327, "type": "number" } }, "required": [ "operator", "value", "measure" ], "type": "object" } }, "required": [ "comparisonMeasureValueFilter" ], "type": "object" }, "CsvConvertOptions": { "description": "Options for converting CSV files when reading.", "properties": { "autoDictEncode": { "description": "Whether to try to automatically dict-encode string / binary data.", "type": "boolean" }, "autoDictMaxCardinality": { "description": "The maximum dictionary cardinality for autoDictEncode.", "format": "int32", "type": "integer" }, "checkUtf8": { "description": "Whether to check UTF8 validity of string columns.", "type": "boolean" }, "columnTypes": { "description": "Information about the column types in the table.", "items": { "$ref": "#/components/schemas/CsvConvertOptionsColumnType" }, "type": "array" }, "decimalPoint": { "description": "The character used as decimal point in floating-point and decimal data.", "type": "string" }, "falseValues": { "description": "Sequence of strings that denote false Booleans in the data.", "items": { "description": "Sequence of strings that denote false Booleans in the data.", "type": "string" }, "type": "array" }, "includeColumns": { "description": "The names of columns to include in the Table. If empty, the Table will include all columns from the CSV file. If not empty, only these columns will be included, in this order.", "items": { "description": "The names of columns to include in the Table. If empty, the Table will include all columns from the CSV file. If not empty, only these columns will be included, in this order.", "type": "string" }, "type": "array" }, "includeMissingColumns": { "description": "If false, columns in includeColumns but not in the CSV file will error out.", "type": "boolean" }, "nullValues": { "description": "Sequence of strings that denote nulls in the data.", "items": { "description": "Sequence of strings that denote nulls in the data.", "type": "string" }, "type": "array" }, "quotedStringsCanBeNull": { "description": "Whether quoted values can be null.", "type": "boolean" }, "stringsCanBeNull": { "description": "Whether string / binary columns can have null values.", "type": "boolean" }, "timestampParsers": { "description": "Sequence of strptime()-compatible format strings, tried in order when attempting to infer or convert timestamp values.", "items": { "description": "Sequence of strptime()-compatible format strings, tried in order when attempting to infer or convert timestamp values.", "type": "string" }, "type": "array" }, "trueValues": { "description": "Sequence of strings that denote true Booleans in the data.", "items": { "description": "Sequence of strings that denote true Booleans in the data.", "type": "string" }, "type": "array" } }, "type": "object" }, "CsvConvertOptionsColumnType": { "description": "Information about a certain column in the table.", "properties": { "name": { "description": "The column name.", "type": "string" }, "nullable": { "description": "Whether the data in the given column can be null.", "type": "boolean" }, "type": { "description": "The column type.", "type": "string" } }, "type": "object" }, "CsvParseOptions": { "description": "Options for parsing CSV files.", "properties": { "delimiter": { "description": "The character delimiting individual cells in the CSV data.", "type": "string" }, "doubleQuote": { "description": "Whether two quotes in a quoted CSV value denote a single quote in the data.", "type": "boolean" }, "escapeChar": { "description": "The character used optionally for escaping special characters or false to disable escaping.", "type": "object" }, "ignoreEmptyLines": { "description": "Whether empty lines are ignored in CSV input.", "type": "boolean" }, "newlinesInValues": { "description": "Whether newline characters are allowed in CSV values.", "type": "boolean" }, "quoteChar": { "description": "The character used optionally for quoting CSV values or false to disable quoting.", "type": "object" } }, "type": "object" }, "CsvReadOptions": { "description": "Options for reading CSV files.", "properties": { "autoGenerateColumnNames": { "description": "Whether to autogenerate column names if columnNames is empty.", "type": "boolean" }, "blockSize": { "description": "How many bytes to process at a time from the input stream.", "format": "int32", "type": "integer" }, "columnNames": { "description": "The column names of the target table.", "items": { "description": "The column names of the target table.", "type": "string" }, "type": "array" }, "encoding": { "description": "The character encoding of the CSV data.", "type": "string" }, "skipRows": { "description": "The number of rows to skip before the column names (if any) and the CSV data.", "format": "int32", "type": "integer" }, "skipRowsAfterNames": { "description": "The number of rows to skip after the column names.", "format": "int32", "type": "integer" }, "useThreads": { "description": "Whether to use multiple threads to accelerate reading.", "type": "boolean" } }, "type": "object" }, "CustomLabel": { "description": "Custom label object override.", "properties": { "title": { "description": "Override value.", "type": "string" } }, "required": [ "title" ], "type": "object" }, "CustomMetric": { "description": "Custom metric object override.", "properties": { "format": { "description": "Format override.", "type": "string" }, "title": { "description": "Metric title override.", "type": "string" } }, "required": [ "format", "title" ], "type": "object" }, "CustomOverride": { "description": "Custom cell value overrides (IDs will be replaced with specified values).", "properties": { "labels": { "additionalProperties": { "$ref": "#/components/schemas/CustomLabel" }, "description": "Map of CustomLabels with keys used as placeholders in document.", "type": "object" }, "metrics": { "additionalProperties": { "$ref": "#/components/schemas/CustomMetric" }, "description": "Map of CustomMetrics with keys used as placeholders in document.", "type": "object" } }, "type": "object" }, "DashboardPermissions": { "properties": { "rules": { "description": "List of rules", "items": { "$ref": "#/components/schemas/RulePermission" }, "type": "array" }, "userGroups": { "description": "List of user groups", "items": { "$ref": "#/components/schemas/UserGroupPermission" }, "type": "array" }, "users": { "description": "List of users", "items": { "$ref": "#/components/schemas/UserPermission" }, "type": "array" } }, "required": [ "rules", "userGroups", "users" ], "type": "object" }, "DashboardPermissionsAssignment": { "description": "Desired levels of permissions for an assignee.", "properties": { "permissions": { "items": { "enum": [ "EDIT", "SHARE", "VIEW" ], "type": "string" }, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "DataColumnLocator": { "description": "Mapping from dimension items (either 'localIdentifier' from 'AttributeItem', or \"measureGroup\") to their respective values. This effectively specifies the path (location) of the data column used for sorting. Therefore values for all dimension items must be specified.", "example": { "dim2": { "measureGroup": "m1", "status": "lost" } }, "properties": { "properties": { "additionalProperties": { "description": "Mapping from dimension items (either 'localIdentifier' from 'AttributeItem', or \"measureGroup\") to their respective values. This effectively specifies the path (location) of the data column used for sorting. Therefore values for all dimension items must be specified.", "example": "{\"status\":\"lost\",\"measureGroup\":\"m1\"}", "type": "string" }, "description": "Mapping from dimension items (either 'localIdentifier' from 'AttributeItem', or \"measureGroup\") to their respective values. This effectively specifies the path (location) of the data column used for sorting. Therefore values for all dimension items must be specified.", "example": { "measureGroup": "m1", "status": "lost" }, "type": "object" } }, "required": [ "properties" ], "type": "object" }, "DataColumnLocators": { "properties": { "properties": { "additionalProperties": { "$ref": "#/components/schemas/DataColumnLocator" }, "description": "Mapping from dimensions to data column locators.", "example": { "dim2": { "measureGroup": "m1", "status": "lost" } }, "type": "object" } }, "type": "object" }, "DataSourceParameter": { "description": "A parameter for testing data source connection", "properties": { "name": { "description": "Parameter name.", "type": "string" }, "value": { "description": "Parameter value.", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "DataSourcePermissionAssignment": { "description": "Data source permission assignments", "properties": { "assigneeIdentifier": { "$ref": "#/components/schemas/AssigneeIdentifier" }, "permissions": { "items": { "enum": [ "MANAGE", "USE" ], "type": "string" }, "type": "array" } }, "required": [ "assigneeIdentifier", "permissions" ], "type": "object" }, "DataSourceSchemata": { "description": "Result of getSchemata. Contains list of available DB schema names.", "properties": { "schemaNames": { "items": { "type": "string" }, "type": "array" } }, "required": [ "schemaNames" ], "type": "object" }, "DataSourceTableIdentifier": { "description": "An id of the table. Including ID of data source.", "example": { "dataSourceId": "my-postgres", "id": "customers", "type": "DATA_SOURCE" }, "properties": { "dataSourceId": { "description": "Data source ID.", "example": "my-postgres", "maxLength": 255, "type": "string" }, "id": { "description": "ID of table.", "example": "customers", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "path": { "description": "Path to table.", "example": [ "table_schema", "table_name" ], "items": { "example": "table_name", "type": "string" }, "nullable": true, "type": "array" }, "type": { "description": "Data source entity type.", "enum": [ "dataSource" ], "example": "dataSource", "type": "string" } }, "required": [ "dataSourceId", "id", "type" ], "type": "object" }, "DatasetGrain": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "attribute", "date" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "DatasetReferenceIdentifier": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "dataset" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "DatasetWorkspaceDataFilterIdentifier": { "description": "Identifier of a workspace data filter.", "properties": { "id": { "description": "Workspace Data Filters ID.", "example": "country_id", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Filter type.", "enum": [ "workspaceDataFilter" ], "example": "workspaceDataFilter", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "DateFilter": { "description": "Abstract filter definition type for dates.", "oneOf": [ { "$ref": "#/components/schemas/AbsoluteDateFilter" }, { "$ref": "#/components/schemas/RelativeDateFilter" } ], "type": "object" }, "DeclarativeAnalyticalDashboard": { "properties": { "content": { "$ref": "#/components/schemas/JsonNode" }, "createdAt": { "description": "Time of the entity creation.", "example": "2023-07-20 12:30", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, "description": { "description": "Analytical dashboard description.", "example": "Period to period comparison of revenues in main sectors.", "maxLength": 10000, "type": "string" }, "id": { "description": "Analytical dashboard ID.", "example": "revenues-analysis", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "modifiedAt": { "description": "Time of the last entity modification.", "example": "2023-07-20 12:30", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "modifiedBy": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, "permissions": { "description": "A list of permissions.", "items": { "oneOf": [ { "$ref": "#/components/schemas/DeclarativeAnalyticalDashboardPermissionForAssignee" }, { "$ref": "#/components/schemas/DeclarativeAnalyticalDashboardPermissionForAssigneeRule" } ] }, "type": "array" }, "tags": { "description": "A list of tags.", "example": [ "Revenues" ], "items": { "description": "A list of tags.", "example": "[\"Revenues\"]", "type": "string" }, "type": "array", "uniqueItems": true }, "title": { "description": "Analytical dashboard title.", "example": "Revenues analysis", "maxLength": 255, "type": "string" } }, "required": [ "content", "id", "title" ], "type": "object" }, "DeclarativeAnalyticalDashboardExtension": { "properties": { "id": { "description": "Analytical dashboard ID.", "example": "revenues-analysis", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "permissions": { "description": "A list of permissions.", "items": { "oneOf": [ { "$ref": "#/components/schemas/DeclarativeAnalyticalDashboardPermissionForAssignee" }, { "$ref": "#/components/schemas/DeclarativeAnalyticalDashboardPermissionForAssigneeRule" } ] }, "type": "array" } }, "required": [ "id", "permissions" ], "type": "object" }, "DeclarativeAnalyticalDashboardPermissionAssignment": { "description": "Analytical dashboard permission.", "properties": { "name": { "description": "Permission name.", "enum": [ "EDIT", "SHARE", "VIEW" ], "type": "string" } }, "required": [ "name" ], "type": "object" }, "DeclarativeAnalyticalDashboardPermissionForAssignee": { "allOf": [ { "$ref": "#/components/schemas/DeclarativeAnalyticalDashboardPermissionAssignment" }, { "properties": { "assignee": { "$ref": "#/components/schemas/AssigneeIdentifier" } }, "type": "object" } ], "description": "Analytical dashboard permission for an assignee.", "required": [ "assignee", "name" ], "type": "object" }, "DeclarativeAnalyticalDashboardPermissionForAssigneeRule": { "allOf": [ { "$ref": "#/components/schemas/DeclarativeAnalyticalDashboardPermissionAssignment" }, { "properties": { "assigneeRule": { "$ref": "#/components/schemas/AssigneeRule" } }, "type": "object" } ], "description": "Analytical dashboard permission for a collection of assignees identified by a rule.", "required": [ "assigneeRule", "name" ], "type": "object" }, "DeclarativeAnalytics": { "description": "Entities describing users' view on data.", "properties": { "analytics": { "$ref": "#/components/schemas/DeclarativeAnalyticsLayer" } }, "type": "object" }, "DeclarativeAnalyticsLayer": { "properties": { "analyticalDashboardExtensions": { "description": "A list of dashboard permissions assigned to a related dashboard.", "items": { "$ref": "#/components/schemas/DeclarativeAnalyticalDashboardExtension" }, "type": "array" }, "analyticalDashboards": { "description": "A list of analytical dashboards available in the model.", "items": { "$ref": "#/components/schemas/DeclarativeAnalyticalDashboard" }, "type": "array" }, "attributeHierarchies": { "description": "A list of attribute hierarchies.", "items": { "$ref": "#/components/schemas/DeclarativeAttributeHierarchy" }, "type": "array" }, "dashboardPlugins": { "description": "A list of dashboard plugins available in the model.", "items": { "$ref": "#/components/schemas/DeclarativeDashboardPlugin" }, "type": "array" }, "filterContexts": { "description": "A list of filter contexts available in the model.", "items": { "$ref": "#/components/schemas/DeclarativeFilterContext" }, "type": "array" }, "metrics": { "description": "A list of metrics available in the model.", "items": { "$ref": "#/components/schemas/DeclarativeMetric" }, "type": "array" }, "visualizationObjects": { "description": "A list of visualization objects available in the model.", "items": { "$ref": "#/components/schemas/DeclarativeVisualizationObject" }, "type": "array" } }, "type": "object" }, "DeclarativeAttribute": { "description": "A dataset attribute.", "properties": { "defaultView": { "$ref": "#/components/schemas/LabelIdentifier" }, "description": { "description": "Attribute description.", "example": "Customer name including first and last name.", "maxLength": 10000, "type": "string" }, "id": { "description": "Attribute ID.", "example": "attr.customers.customer_name", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "labels": { "description": "An array of attribute labels.", "items": { "$ref": "#/components/schemas/DeclarativeLabel" }, "type": "array" }, "sortColumn": { "description": "Attribute sort column.", "example": "customer_name", "maxLength": 255, "type": "string" }, "sortDirection": { "description": "Attribute sort direction.", "enum": [ "ASC", "DESC" ], "example": "\"ASC\" | \"DESC\"", "type": "string" }, "sourceColumn": { "description": "A name of the source column that is the primary label", "example": "customer_name", "maxLength": 255, "type": "string" }, "sourceColumnDataType": { "description": "A type of the source column", "enum": [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], "example": "STRING", "maxLength": 255, "type": "string" }, "tags": { "description": "A list of tags.", "example": [ "Customers" ], "items": { "description": "A list of tags.", "example": "[\"Customers\"]", "type": "string" }, "type": "array", "uniqueItems": true }, "title": { "description": "Attribute title.", "example": "Customer Name", "maxLength": 255, "type": "string" } }, "required": [ "id", "labels", "sourceColumn", "title" ], "type": "object" }, "DeclarativeAttributeHierarchy": { "properties": { "content": { "$ref": "#/components/schemas/JsonNode" }, "createdAt": { "description": "Time of the entity creation.", "example": "[\"2023-07-20 12:30\"]", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, "description": { "description": "Attribute hierarchy object description.", "example": "Simple number for total goods in current production.", "maxLength": 10000, "type": "string" }, "id": { "description": "Attribute hierarchy object ID.", "example": "hierarchy-1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "modifiedAt": { "description": "Time of the last entity modification.", "example": "[\"2023-07-20 12:30\"]", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "modifiedBy": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, "tags": { "description": "A list of tags.", "example": [ "Revenues" ], "items": { "description": "A list of tags.", "example": "[\"Revenues\"]", "type": "string" }, "type": "array", "uniqueItems": true }, "title": { "description": "Attribute hierarchy object title.", "example": "Count of goods", "maxLength": 255, "type": "string" } }, "required": [ "content", "id", "title" ], "type": "object" }, "DeclarativeColorPalette": { "description": "Color palette and its properties.", "properties": { "content": { "$ref": "#/components/schemas/JsonNode" }, "id": { "type": "string" }, "name": { "maxLength": 255, "type": "string" } }, "required": [ "content", "id", "name" ], "type": "object" }, "DeclarativeColumn": { "description": "A table column.", "properties": { "dataType": { "description": "Column type", "enum": [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], "example": "INT", "type": "string" }, "isPrimaryKey": { "description": "Is column part of primary key?", "type": "boolean" }, "name": { "description": "Column name", "example": "customer_id", "maxLength": 255, "pattern": "^[^\u0000]*$", "type": "string" }, "referencedTableColumn": { "description": "Referenced table (Foreign key)", "example": "customer_id", "maxLength": 255, "type": "string" }, "referencedTableId": { "description": "Referenced table (Foreign key)", "example": "customers", "maxLength": 255, "type": "string" } }, "required": [ "dataType", "name" ], "type": "object" }, "DeclarativeCspDirective": { "properties": { "directive": { "maxLength": 255, "type": "string" }, "sources": { "items": { "type": "string" }, "type": "array" } }, "required": [ "directive", "sources" ], "type": "object" }, "DeclarativeCustomApplicationSetting": { "description": "Custom application setting and its value.", "properties": { "applicationName": { "description": "The application id", "example": "Modeler", "maxLength": 255, "type": "string" }, "content": { "$ref": "#/components/schemas/JsonNode" }, "id": { "description": "Custom Application Setting ID.", "example": "modeler.demo", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, "required": [ "applicationName", "content", "id" ], "type": "object" }, "DeclarativeDashboardPlugin": { "properties": { "content": { "$ref": "#/components/schemas/JsonNode" }, "createdAt": { "description": "Time of the entity creation.", "example": "[\"2023-07-20 12:30\"]", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, "description": { "description": "Dashboard plugin description.", "example": "Three dimensional view of data.", "maxLength": 10000, "type": "string" }, "id": { "description": "Dashboard plugin object ID.", "example": "dashboard-plugin-1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "modifiedAt": { "description": "Time of the last entity modification.", "example": "[\"2023-07-20 12:30\"]", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "modifiedBy": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, "tags": { "description": "A list of tags.", "example": [ "Revenues" ], "items": { "description": "A list of tags.", "example": "[\"Revenues\"]", "type": "string" }, "type": "array", "uniqueItems": true }, "title": { "description": "Dashboard plugin object title.", "example": "3D map renderer", "maxLength": 255, "type": "string" } }, "required": [ "content", "id", "title" ], "type": "object" }, "DeclarativeDataSource": { "description": "A data source and its properties.", "properties": { "cachePath": { "description": "Path to schema, where intermediate caches are stored.", "example": "[ \"dfs\", \"data\" ]. Example used in Apache Drill.", "items": { "type": "string" }, "type": "array" }, "cacheStrategy": { "description": "Determines how the results coming from a particular datasource should be cached.\n- ALWAYS: The results from the datasource should be cached normally (the default).\n- NEVER: The results from the datasource should never be cached.", "enum": [ "ALWAYS", "NEVER" ], "type": "string" }, "decodedParameters": { "items": { "$ref": "#/components/schemas/Parameter" }, "type": "array" }, "enableCaching": { "description": "Enable caching of intermediate results.", "example": false, "type": "boolean" }, "id": { "description": "Data source ID.", "example": "pg_local_docker-demo", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "name": { "description": "Name of the data source.", "example": "postgres demo", "maxLength": 255, "type": "string" }, "parameters": { "items": { "$ref": "#/components/schemas/Parameter" }, "type": "array" }, "password": { "description": "Password for the data-source user, property is never returned back.", "example": "*****", "maxLength": 255, "type": "string" }, "permissions": { "items": { "$ref": "#/components/schemas/DeclarativeDataSourcePermission" }, "type": "array" }, "schema": { "description": "A scheme/database with the data.", "example": "demo", "maxLength": 255, "type": "string" }, "token": { "description": "Token as an alternative to username and password.", "example": "Bigquery service account JSON. Encode it using base64!", "maxLength": 10000, "type": "string" }, "type": { "description": "Type of database.", "enum": [ "POSTGRESQL", "REDSHIFT", "VERTICA", "SNOWFLAKE", "ADS", "BIGQUERY", "MSSQL", "PRESTO", "DREMIO", "DRILL", "GREENPLUM", "AZURESQL", "SYNAPSESQL", "DATABRICKS", "GDSTORAGE", "CLICKHOUSE", "MYSQL", "MARIADB" ], "example": "POSTGRESQL", "type": "string" }, "url": { "description": "An connection string relevant to type of database.", "example": "jdbc:postgresql://postgres:5432/gooddata", "maxLength": 255, "type": "string" }, "username": { "description": "User with permission connect the data source/database.", "example": "demo", "maxLength": 255, "type": "string" } }, "required": [ "id", "name", "schema", "type" ], "type": "object" }, "DeclarativeDataSourcePermission": { "properties": { "assignee": { "$ref": "#/components/schemas/AssigneeIdentifier" }, "name": { "description": "Permission name.", "enum": [ "MANAGE", "USE" ], "type": "string" } }, "required": [ "assignee", "name" ], "type": "object" }, "DeclarativeDataSourcePermissions": { "description": "Data source permissions.", "properties": { "permissions": { "items": { "$ref": "#/components/schemas/DeclarativeDataSourcePermission" }, "type": "array" } }, "type": "object" }, "DeclarativeDataSources": { "description": "A data source and its properties.", "properties": { "dataSources": { "items": { "$ref": "#/components/schemas/DeclarativeDataSource" }, "type": "array" } }, "required": [ "dataSources" ], "type": "object" }, "DeclarativeDataset": { "description": "A dataset defined by its properties.", "properties": { "attributes": { "description": "An array of attributes.", "items": { "$ref": "#/components/schemas/DeclarativeAttribute" }, "type": "array" }, "dataSourceTableId": { "$ref": "#/components/schemas/DataSourceTableIdentifier" }, "description": { "description": "A dataset description.", "example": "The customers of ours.", "maxLength": 10000, "type": "string" }, "facts": { "description": "An array of facts.", "items": { "$ref": "#/components/schemas/DeclarativeFact" }, "type": "array" }, "grain": { "description": "An array of grain identifiers.", "items": { "$ref": "#/components/schemas/GrainIdentifier" }, "type": "array" }, "id": { "description": "The Dataset ID. This ID is further used to refer to this instance of dataset.", "example": "customers", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "references": { "description": "An array of references.", "items": { "$ref": "#/components/schemas/DeclarativeReference" }, "type": "array" }, "sql": { "$ref": "#/components/schemas/DeclarativeDatasetSql" }, "tags": { "description": "A list of tags.", "example": [ "Customers" ], "items": { "description": "A list of tags.", "example": "[\"Customers\"]", "type": "string" }, "type": "array", "uniqueItems": true }, "title": { "description": "A dataset title.", "example": "Customers", "maxLength": 255, "type": "string" }, "workspaceDataFilterColumns": { "description": "An array of columns which are available for match to implicit workspace data filters.", "items": { "$ref": "#/components/schemas/DeclarativeWorkspaceDataFilterColumn" }, "type": "array" }, "workspaceDataFilterReferences": { "description": "An array of explicit workspace data filters.", "items": { "$ref": "#/components/schemas/DeclarativeWorkspaceDataFilterReferences" }, "type": "array" } }, "required": [ "grain", "id", "references", "title" ], "type": "object" }, "DeclarativeDatasetExtension": { "description": "A dataset extension properties.", "properties": { "id": { "description": "The Dataset ID. This ID is further used to refer to this instance of dataset.", "example": "customers", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "workspaceDataFilterReferences": { "description": "An array of explicit workspace data filters.", "items": { "$ref": "#/components/schemas/DeclarativeWorkspaceDataFilterReferences" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "DeclarativeDatasetSql": { "description": "SQL defining this dataset.", "example": { "dataSourceId": "my-postgres", "statement": "SELECT * FROM some_table" }, "properties": { "dataSourceId": { "description": "Data source ID.", "example": "my-postgres", "type": "string" }, "statement": { "description": "SQL statement.", "example": "SELECT * FROM some_table", "type": "string" } }, "required": [ "dataSourceId", "statement" ], "type": "object" }, "DeclarativeDateDataset": { "description": "A date dataset.", "properties": { "description": { "description": "Date dataset description.", "example": "A customer order date", "maxLength": 10000, "type": "string" }, "granularities": { "description": "An array of date granularities. All listed granularities will be available for date dataset.", "items": { "enum": [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR" ], "type": "string" }, "type": "array" }, "granularitiesFormatting": { "$ref": "#/components/schemas/GranularitiesFormatting" }, "id": { "description": "Date dataset ID.", "example": "date", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "tags": { "description": "A list of tags.", "example": [ "Customer dates" ], "items": { "description": "A list of tags.", "example": "[\"Customer dates\"]", "type": "string" }, "type": "array", "uniqueItems": true }, "title": { "description": "Date dataset title.", "example": "Date", "maxLength": 255, "type": "string" } }, "required": [ "granularities", "granularitiesFormatting", "id", "title" ], "type": "object" }, "DeclarativeFact": { "description": "A dataset fact.", "properties": { "description": { "description": "Fact description.", "example": "A number of orders created by the customer - including all orders, even the non-delivered ones.", "maxLength": 10000, "type": "string" }, "id": { "description": "Fact ID.", "example": "fact.customer_order_count", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "sourceColumn": { "description": "A name of the source column in the table.", "example": "customer_order_count", "maxLength": 255, "type": "string" }, "sourceColumnDataType": { "description": "A type of the source column", "enum": [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], "example": "NUMERIC", "maxLength": 255, "type": "string" }, "tags": { "description": "A list of tags.", "example": [ "Customers" ], "items": { "description": "A list of tags.", "example": "[\"Customers\"]", "type": "string" }, "type": "array", "uniqueItems": true }, "title": { "description": "Fact title.", "example": "Customer order count", "maxLength": 255, "type": "string" } }, "required": [ "id", "sourceColumn", "title" ], "type": "object" }, "DeclarativeFilterContext": { "properties": { "content": { "$ref": "#/components/schemas/JsonNode" }, "description": { "description": "Filter Context description.", "example": "Filter Context for Sales team.", "maxLength": 10000, "type": "string" }, "id": { "description": "Filter Context ID.", "example": "filter-sales", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "tags": { "description": "A list of tags.", "example": [ "Revenues" ], "items": { "description": "A list of tags.", "example": "[\"Revenues\"]", "type": "string" }, "type": "array", "uniqueItems": true }, "title": { "description": "Filter Context title.", "example": "Filter Context for Sales team", "maxLength": 255, "type": "string" } }, "required": [ "content", "id", "title" ], "type": "object" }, "DeclarativeJwk": { "description": "A declarative form of the JWK.", "properties": { "content": { "$ref": "#/components/schemas/DeclarativeJwkSpecification" }, "id": { "description": "JWK object ID.", "example": "jwk-1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, "required": [ "content", "id" ], "type": "object" }, "DeclarativeJwkSpecification": { "description": "Declarative specification of the cryptographic key.", "oneOf": [ { "$ref": "#/components/schemas/DeclarativeRsaSpecification" } ], "type": "object" }, "DeclarativeLabel": { "description": "A attribute label.", "properties": { "description": { "description": "Label description.", "example": "Customer name", "maxLength": 10000, "type": "string" }, "id": { "description": "Label ID.", "example": "label.customer_name", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "sourceColumn": { "description": "A name of the source column in the table.", "example": "customer_name", "maxLength": 255, "type": "string" }, "sourceColumnDataType": { "description": "A type of the source column", "enum": [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], "example": "STRING", "maxLength": 255, "type": "string" }, "tags": { "description": "A list of tags.", "example": [ "Customers" ], "items": { "description": "A list of tags.", "example": "[\"Customers\"]", "type": "string" }, "type": "array", "uniqueItems": true }, "title": { "description": "Label title.", "example": "Customer name", "maxLength": 255, "type": "string" }, "valueType": { "description": "Specific type of label", "enum": [ "TEXT", "HYPERLINK", "GEO", "GEO_LONGITUDE", "GEO_LATITUDE" ], "example": "\"TEXT\" | \"HYPERLINK\" | \"GEO\" | \"GEO_LONGITUDE\" | \"GEO_LATITUDE\"", "type": "string" } }, "required": [ "id", "sourceColumn", "title" ], "type": "object" }, "DeclarativeLdm": { "description": "A logical data model (LDM) representation.", "properties": { "datasetExtensions": { "description": "An array containing extensions for datasets defined in parent workspaces.", "items": { "$ref": "#/components/schemas/DeclarativeDatasetExtension" }, "type": "array" }, "datasets": { "description": "An array containing datasets.", "items": { "$ref": "#/components/schemas/DeclarativeDataset" }, "type": "array" }, "dateInstances": { "description": "An array containing date-related datasets.", "items": { "$ref": "#/components/schemas/DeclarativeDateDataset" }, "type": "array" } }, "type": "object" }, "DeclarativeMetric": { "properties": { "content": { "$ref": "#/components/schemas/JsonNode" }, "createdAt": { "description": "Time of the entity creation.", "example": "[\"2023-07-20 12:30\"]", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, "description": { "description": "Metric description.", "example": "Sales for all the data available.", "maxLength": 10000, "type": "string" }, "id": { "description": "Metric ID.", "example": "total-sales", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "modifiedAt": { "description": "Time of the last entity modification.", "example": "[\"2023-07-20 12:30\"]", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "modifiedBy": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, "tags": { "description": "A list of tags.", "example": [ "Revenues" ], "items": { "description": "A list of tags.", "example": "[\"Revenues\"]", "type": "string" }, "type": "array", "uniqueItems": true }, "title": { "description": "Metric title.", "example": "Total sales", "maxLength": 255, "type": "string" } }, "required": [ "content", "id", "title" ], "type": "object" }, "DeclarativeModel": { "description": "A data model structured as a set of its attributes.", "properties": { "ldm": { "$ref": "#/components/schemas/DeclarativeLdm" } }, "type": "object" }, "DeclarativeOrganization": { "description": "Complete definition of an organization in a declarative form.", "properties": { "dataSources": { "items": { "$ref": "#/components/schemas/DeclarativeDataSource" }, "type": "array" }, "jwks": { "items": { "$ref": "#/components/schemas/DeclarativeJwk" }, "type": "array" }, "organization": { "$ref": "#/components/schemas/DeclarativeOrganizationInfo" }, "userGroups": { "items": { "$ref": "#/components/schemas/DeclarativeUserGroup" }, "type": "array" }, "users": { "items": { "$ref": "#/components/schemas/DeclarativeUser" }, "type": "array" }, "workspaceDataFilters": { "items": { "$ref": "#/components/schemas/DeclarativeWorkspaceDataFilter" }, "type": "array" }, "workspaces": { "items": { "$ref": "#/components/schemas/DeclarativeWorkspace" }, "type": "array" } }, "required": [ "organization" ], "type": "object" }, "DeclarativeOrganizationInfo": { "description": "Information available about an organization.", "properties": { "colorPalettes": { "description": "A list of color palettes.", "items": { "$ref": "#/components/schemas/DeclarativeColorPalette" }, "type": "array" }, "cspDirectives": { "description": "A list of CSP directives.", "items": { "$ref": "#/components/schemas/DeclarativeCspDirective" }, "type": "array" }, "earlyAccess": { "description": "Early access defined on level Organization", "maxLength": 255, "type": "string" }, "hostname": { "description": "Formal hostname used in deployment.", "example": "alpha.com", "maxLength": 255, "type": "string" }, "id": { "description": "Identifier of the organization.", "example": "Alpha corporation", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "name": { "description": "Formal name of the organization.", "example": "Alpha corporation", "maxLength": 255, "type": "string" }, "oauthClientId": { "description": "Identifier of the authentication provider", "maxLength": 255, "type": "string" }, "oauthClientSecret": { "description": "Communication secret of the authentication provider (never returned back).", "maxLength": 255, "type": "string" }, "oauthIssuerId": { "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", "example": "myOidcProvider", "maxLength": 255, "type": "string" }, "oauthIssuerLocation": { "description": "URI of the authentication provider.", "maxLength": 255, "type": "string" }, "oauthSubjectIdClaim": { "description": "Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.", "example": "oid", "maxLength": 255, "type": "string" }, "permissions": { "items": { "$ref": "#/components/schemas/DeclarativeOrganizationPermission" }, "type": "array" }, "settings": { "description": "A list of organization settings.", "items": { "$ref": "#/components/schemas/DeclarativeSetting" }, "type": "array" }, "themes": { "description": "A list of themes.", "items": { "$ref": "#/components/schemas/DeclarativeTheme" }, "type": "array" } }, "required": [ "hostname", "id", "name", "permissions" ], "type": "object" }, "DeclarativeOrganizationPermission": { "description": "Definition of an organization permission assigned to a user/user-group.", "properties": { "assignee": { "$ref": "#/components/schemas/AssigneeIdentifier" }, "name": { "description": "Permission name.", "enum": [ "MANAGE", "SELF_CREATE_TOKEN" ], "type": "string" } }, "required": [ "assignee", "name" ], "type": "object" }, "DeclarativeReference": { "description": "A dataset reference.", "properties": { "identifier": { "$ref": "#/components/schemas/ReferenceIdentifier" }, "multivalue": { "description": "The multi-value flag enables many-to-many cardinality for references.", "example": false, "type": "boolean" }, "sourceColumnDataTypes": { "deprecated": true, "description": "An array of source column data types for a given reference. Deprecated, use 'sources' instead.", "items": { "enum": [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], "type": "string" }, "type": "array" }, "sourceColumns": { "deprecated": true, "description": "An array of source column names for a given reference. Deprecated, use 'sources' instead.", "example": [ "customer_id" ], "items": { "type": "string" }, "type": "array" }, "sources": { "description": "An array of source columns for a given reference.", "items": { "$ref": "#/components/schemas/DeclarativeReferenceSource" }, "type": "array" } }, "required": [ "identifier", "multivalue" ], "type": "object" }, "DeclarativeReferenceSource": { "description": "A dataset reference source column description.", "properties": { "column": { "description": "A name of the source column in the table.", "example": "customer_id", "maxLength": 255, "type": "string" }, "dataType": { "description": "A type of the source column.", "enum": [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], "example": "STRING", "maxLength": 255, "type": "string" }, "target": { "$ref": "#/components/schemas/GrainIdentifier" } }, "required": [ "column", "target" ], "type": "object" }, "DeclarativeRsaSpecification": { "description": "Declarative specification of the cryptographic key.", "properties": { "alg": { "description": "Algorithm intended for use with the key.", "enum": [ "RS256", "RS384", "RS512" ], "example": "RS256", "type": "string" }, "e": { "description": "parameter contains the exponent value for the RSA public key.", "type": "string" }, "kid": { "description": "Parameter is used to match a specific key.", "example": "key.001", "maxLength": 255, "pattern": "^[^.]", "type": "string" }, "kty": { "description": "Key type parameter", "enum": [ "RSA" ], "example": "RSA", "type": "string" }, "n": { "description": "Parameter contains the modulus value for the RSA public key.", "type": "string" }, "use": { "description": "Parameter identifies the intended use of the public key.", "enum": [ "sig" ], "example": "sig", "type": "string" }, "x5c": { "description": "Parameter contains a chain of one or more PKIX certificates.", "items": { "type": "string" }, "type": "array" }, "x5t": { "description": "Parameter is a base64url-encoded SHA-1 thumbprint of the DER encoding of an X.509 certificate.", "type": "string" } }, "required": [ "alg", "e", "kid", "kty", "n", "use" ], "type": "object" }, "DeclarativeSetting": { "description": "Setting and its value.", "properties": { "content": { "$ref": "#/components/schemas/JsonNode" }, "id": { "description": "Setting ID.", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Type of the setting.", "enum": [ "TIMEZONE", "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "WHITE_LABELING", "LOCALE", "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", "TIMEZONE_VALIDATION_ENABLED" ], "example": "TIMEZONE", "type": "string" } }, "required": [ "id" ], "type": "object" }, "DeclarativeSingleWorkspacePermission": { "properties": { "assignee": { "$ref": "#/components/schemas/AssigneeIdentifier" }, "name": { "description": "Permission name.", "enum": [ "MANAGE", "ANALYZE", "EXPORT", "EXPORT_TABULAR", "EXPORT_PDF", "VIEW" ], "type": "string" } }, "required": [ "assignee", "name" ], "type": "object" }, "DeclarativeTable": { "description": "A database table.", "properties": { "columns": { "description": "An array of physical columns", "items": { "$ref": "#/components/schemas/DeclarativeColumn" }, "type": "array" }, "id": { "description": "Table id.", "example": "customers", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "namePrefix": { "description": "Table or view name prefix used in scan. Will be stripped when generating LDM.", "example": "out_gooddata", "maxLength": 255, "type": "string" }, "path": { "description": "Path to table.", "example": [ "table_schema", "table_name" ], "items": { "example": "table_name", "type": "string" }, "type": "array" }, "type": { "description": "Table type: TABLE or VIEW.", "example": "TABLE", "type": "string" } }, "required": [ "columns", "id", "path", "type" ], "type": "object" }, "DeclarativeTables": { "description": "A physical data model (PDM) tables.", "properties": { "tables": { "description": "An array of physical database tables.", "items": { "$ref": "#/components/schemas/DeclarativeTable" }, "type": "array" } }, "required": [ "tables" ], "type": "object" }, "DeclarativeTheme": { "description": "Theme and its properties.", "properties": { "content": { "$ref": "#/components/schemas/JsonNode" }, "id": { "type": "string" }, "name": { "maxLength": 255, "type": "string" } }, "required": [ "content", "id", "name" ], "type": "object" }, "DeclarativeUser": { "description": "A user and its properties", "properties": { "authId": { "description": "User identification in the authentication manager.", "maxLength": 255, "type": "string" }, "email": { "description": "User email address", "example": "user@example.com", "maxLength": 255, "type": "string" }, "firstname": { "description": "User first name", "example": "John", "maxLength": 255, "type": "string" }, "id": { "description": "User identifier.", "example": "employee123", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "lastname": { "description": "User last name", "example": "Wick", "maxLength": 255, "type": "string" }, "permissions": { "items": { "$ref": "#/components/schemas/DeclarativeUserPermission" }, "type": "array" }, "settings": { "description": "A list of user settings.", "items": { "$ref": "#/components/schemas/DeclarativeSetting" }, "type": "array" }, "userGroups": { "items": { "$ref": "#/components/schemas/DeclarativeUserGroupIdentifier" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "DeclarativeUserDataFilter": { "description": "User Data Filters serving the filtering of what data users can see in workspaces.", "properties": { "description": { "description": "User Data Filters setting description.", "example": "ID of country setting", "maxLength": 10000, "type": "string" }, "id": { "description": "User Data Filters ID. This ID is further used to refer to this instance.", "example": "country_id_setting", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "maql": { "description": "Expression in MAQL specifying the User Data Filter", "example": "{label/country} = \"USA\" AND {label/date.year} = THIS(YEAR)", "maxLength": 10000, "type": "string" }, "tags": { "description": "A list of tags.", "example": [ "Revenues" ], "items": { "description": "A list of tags.", "example": "[\"Revenues\"]", "type": "string" }, "type": "array", "uniqueItems": true }, "title": { "description": "User Data Filters setting title.", "example": "Country ID setting", "maxLength": 255, "type": "string" }, "user": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, "userGroup": { "$ref": "#/components/schemas/DeclarativeUserGroupIdentifier" } }, "required": [ "id", "maql", "title" ], "type": "object" }, "DeclarativeUserDataFilters": { "description": "Declarative form of user data filters.", "properties": { "userDataFilters": { "items": { "$ref": "#/components/schemas/DeclarativeUserDataFilter" }, "type": "array" } }, "required": [ "userDataFilters" ], "type": "object" }, "DeclarativeUserGroup": { "description": "A user-group and its properties", "properties": { "id": { "description": "UserGroup identifier.", "example": "employees.all", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "name": { "description": "Name of UserGroup", "example": "admins", "maxLength": 255, "type": "string" }, "parents": { "items": { "$ref": "#/components/schemas/DeclarativeUserGroupIdentifier" }, "type": "array" }, "permissions": { "items": { "$ref": "#/components/schemas/DeclarativeUserGroupPermission" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "DeclarativeUserGroupIdentifier": { "description": "A user group identifier.", "example": { "id": "admins", "type": "userGroup" }, "properties": { "id": { "description": "Identifier of the user group.", "example": "group.admins", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "A type.", "enum": [ "userGroup" ], "example": "userGroup", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "DeclarativeUserGroupPermission": { "description": "Definition of a user-group permission assigned to a user/user-group.", "properties": { "assignee": { "$ref": "#/components/schemas/AssigneeIdentifier" }, "name": { "description": "Permission name.", "enum": [ "SEE" ], "type": "string" } }, "required": [ "assignee", "name" ], "type": "object" }, "DeclarativeUserGroupPermissions": { "description": "Definition of permissions associated with a user-group.", "properties": { "permissions": { "items": { "$ref": "#/components/schemas/DeclarativeUserGroupPermission" }, "type": "array" } }, "type": "object" }, "DeclarativeUserGroups": { "description": "Declarative form of userGroups and its properties.", "properties": { "userGroups": { "items": { "$ref": "#/components/schemas/DeclarativeUserGroup" }, "type": "array" } }, "required": [ "userGroups" ], "type": "object" }, "DeclarativeUserIdentifier": { "description": "A user identifier.", "example": { "id": "example123", "type": "user" }, "properties": { "id": { "description": "User identifier.", "example": "employee123", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "A type.", "enum": [ "user" ], "example": "user", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "DeclarativeUserPermission": { "description": "Definition of a user permission assigned to a user/user-group.", "properties": { "assignee": { "$ref": "#/components/schemas/AssigneeIdentifier" }, "name": { "description": "Permission name.", "enum": [ "SEE" ], "type": "string" } }, "required": [ "assignee", "name" ], "type": "object" }, "DeclarativeUserPermissions": { "description": "Definition of permissions associated with a user.", "properties": { "permissions": { "items": { "$ref": "#/components/schemas/DeclarativeUserPermission" }, "type": "array" } }, "type": "object" }, "DeclarativeUsers": { "description": "Declarative form of users and its properties.", "properties": { "users": { "items": { "$ref": "#/components/schemas/DeclarativeUser" }, "type": "array" } }, "required": [ "users" ], "type": "object" }, "DeclarativeUsersUserGroups": { "description": "Declarative form of both users and user groups and theirs properties.", "properties": { "userGroups": { "items": { "$ref": "#/components/schemas/DeclarativeUserGroup" }, "type": "array" }, "users": { "items": { "$ref": "#/components/schemas/DeclarativeUser" }, "type": "array" } }, "required": [ "userGroups", "users" ], "type": "object" }, "DeclarativeVisualizationObject": { "properties": { "content": { "$ref": "#/components/schemas/JsonNode" }, "createdAt": { "description": "Time of the entity creation.", "example": "[\"2023-07-20 12:30\"]", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, "description": { "description": "Visualization object description.", "example": "Simple number for total goods in current production.", "maxLength": 10000, "type": "string" }, "id": { "description": "Visualization object ID.", "example": "visualization-1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "modifiedAt": { "description": "Time of the last entity modification.", "example": "[\"2023-07-20 12:30\"]", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "modifiedBy": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, "tags": { "description": "A list of tags.", "example": [ "Revenues" ], "items": { "description": "A list of tags.", "example": "[\"Revenues\"]", "type": "string" }, "type": "array", "uniqueItems": true }, "title": { "description": "Visualization object title.", "example": "Count of goods", "maxLength": 255, "type": "string" } }, "required": [ "content", "id", "title" ], "type": "object" }, "DeclarativeWorkspace": { "description": "A declarative form of a particular workspace.", "properties": { "cacheExtraLimit": { "description": "Extra cache limit allocated to specific workspace. In case there is extra cache budget setup for organization, it can be split between multiple workspaces.", "format": "int64", "type": "integer" }, "customApplicationSettings": { "description": "A list of workspace custom settings.", "items": { "$ref": "#/components/schemas/DeclarativeCustomApplicationSetting" }, "type": "array" }, "description": { "description": "Description of the workspace", "maxLength": 255, "type": "string" }, "earlyAccess": { "description": "Early access defined on level Workspace", "maxLength": 255, "type": "string" }, "hierarchyPermissions": { "items": { "$ref": "#/components/schemas/DeclarativeWorkspaceHierarchyPermission" }, "type": "array" }, "id": { "description": "Identifier of a workspace", "example": "alpha.sales", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "model": { "$ref": "#/components/schemas/DeclarativeWorkspaceModel" }, "name": { "description": "Name of a workspace to view.", "example": "Alpha Sales", "maxLength": 255, "type": "string" }, "parent": { "$ref": "#/components/schemas/WorkspaceIdentifier" }, "permissions": { "items": { "$ref": "#/components/schemas/DeclarativeSingleWorkspacePermission" }, "type": "array" }, "prefix": { "description": "Custom prefix of entity identifiers in workspace", "maxLength": 255, "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "settings": { "description": "A list of workspace settings.", "items": { "$ref": "#/components/schemas/DeclarativeSetting" }, "type": "array" }, "userDataFilters": { "description": "A list of workspace user data filters.", "items": { "$ref": "#/components/schemas/DeclarativeUserDataFilter" }, "type": "array" } }, "required": [ "id", "name" ], "type": "object" }, "DeclarativeWorkspaceDataFilter": { "description": "Workspace Data Filters serving the filtering of what data users can see in workspaces.", "properties": { "columnName": { "description": "Workspace Data Filters column name. Data are filtered using this physical column.", "example": "country_id", "maxLength": 255, "type": "string" }, "description": { "description": "Workspace Data Filters description.", "example": "ID of country", "maxLength": 10000, "type": "string" }, "id": { "description": "Workspace Data Filters ID. This ID is further used to refer to this instance.", "example": "country_id", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "title": { "description": "Workspace Data Filters title.", "example": "Country ID", "maxLength": 255, "type": "string" }, "workspace": { "$ref": "#/components/schemas/WorkspaceIdentifier" }, "workspaceDataFilterSettings": { "description": "Filter settings specifying values of filters valid for the workspace.", "items": { "$ref": "#/components/schemas/DeclarativeWorkspaceDataFilterSetting" }, "type": "array" } }, "required": [ "columnName", "id", "title", "workspaceDataFilterSettings" ], "type": "object" }, "DeclarativeWorkspaceDataFilterColumn": { "properties": { "dataType": { "description": "Data type of the column", "enum": [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], "example": "INT", "type": "string" }, "name": { "description": "Name of the column", "example": "customer_id", "type": "string" } }, "required": [ "dataType", "name" ], "type": "object" }, "DeclarativeWorkspaceDataFilterReferences": { "properties": { "filterColumn": { "description": "Filter column name", "example": "filter_id", "type": "string" }, "filterColumnDataType": { "description": "Filter column data type", "enum": [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN" ], "example": "INT", "type": "string" }, "filterId": { "$ref": "#/components/schemas/DatasetWorkspaceDataFilterIdentifier" } }, "required": [ "filterColumn", "filterColumnDataType", "filterId" ], "type": "object" }, "DeclarativeWorkspaceDataFilterSetting": { "description": "Workspace Data Filters serving the filtering of what data users can see in workspaces.", "properties": { "description": { "description": "Workspace Data Filters setting description.", "example": "ID of country setting", "maxLength": 10000, "type": "string" }, "filterValues": { "description": "Only those rows are returned, where columnName from filter matches those values.", "example": [ "US" ], "items": { "description": "Only those rows are returned, where columnName from filter matches those values.", "example": "[\"US\"]", "type": "string" }, "type": "array" }, "id": { "description": "Workspace Data Filters ID. This ID is further used to refer to this instance.", "example": "country_id_setting", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "title": { "description": "Workspace Data Filters setting title.", "example": "Country ID setting", "maxLength": 255, "type": "string" }, "workspace": { "$ref": "#/components/schemas/WorkspaceIdentifier" } }, "required": [ "filterValues", "id", "title", "workspace" ], "type": "object" }, "DeclarativeWorkspaceDataFilters": { "description": "Declarative form of data filters.", "properties": { "workspaceDataFilters": { "items": { "$ref": "#/components/schemas/DeclarativeWorkspaceDataFilter" }, "type": "array" } }, "required": [ "workspaceDataFilters" ], "type": "object" }, "DeclarativeWorkspaceHierarchyPermission": { "properties": { "assignee": { "$ref": "#/components/schemas/AssigneeIdentifier" }, "name": { "description": "Permission name.", "enum": [ "MANAGE", "ANALYZE", "EXPORT", "EXPORT_TABULAR", "EXPORT_PDF", "VIEW" ], "type": "string" } }, "required": [ "assignee", "name" ], "type": "object" }, "DeclarativeWorkspaceModel": { "description": "A declarative form of a model and analytics for a workspace.", "properties": { "analytics": { "$ref": "#/components/schemas/DeclarativeAnalyticsLayer" }, "ldm": { "$ref": "#/components/schemas/DeclarativeLdm" } }, "type": "object" }, "DeclarativeWorkspacePermissions": { "description": "Definition of permissions associated with a workspace.", "properties": { "hierarchyPermissions": { "items": { "$ref": "#/components/schemas/DeclarativeWorkspaceHierarchyPermission" }, "type": "array" }, "permissions": { "items": { "$ref": "#/components/schemas/DeclarativeSingleWorkspacePermission" }, "type": "array" } }, "type": "object" }, "DeclarativeWorkspaces": { "description": "A declarative form of a all workspace layout.", "properties": { "workspaceDataFilters": { "items": { "$ref": "#/components/schemas/DeclarativeWorkspaceDataFilter" }, "type": "array" }, "workspaces": { "items": { "$ref": "#/components/schemas/DeclarativeWorkspace" }, "type": "array" } }, "required": [ "workspaceDataFilters", "workspaces" ], "type": "object" }, "DependentEntitiesGraph": { "properties": { "edges": { "items": { "items": { "$ref": "#/components/schemas/EntityIdentifier" }, "type": "array" }, "type": "array", "uniqueItems": true }, "nodes": { "items": { "$ref": "#/components/schemas/DependentEntitiesNode" }, "type": "array", "uniqueItems": true } }, "required": [ "edges", "nodes" ], "type": "object" }, "DependentEntitiesNode": { "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "type": { "enum": [ "analyticalDashboard", "attribute", "dashboardPlugin", "dataset", "fact", "label", "metric", "userDataFilter", "prompt", "visualizationObject", "filterContext" ], "example": "metric", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "DependentEntitiesRequest": { "properties": { "identifiers": { "items": { "$ref": "#/components/schemas/EntityIdentifier" }, "type": "array" } }, "required": [ "identifiers" ], "type": "object" }, "DependentEntitiesResponse": { "properties": { "graph": { "$ref": "#/components/schemas/DependentEntitiesGraph" } }, "required": [ "graph" ], "type": "object" }, "DependsOn": { "allOf": [ { "$ref": "#/components/schemas/DependsOnItem" }, { "properties": { "complementFilter": { "default": false, "description": "Inverse filtering mode.", "type": "boolean" }, "label": { "description": "Specifies on which label the filter depends on.", "type": "string" }, "values": { "description": "Specifies values of the label for element filtering.", "items": { "nullable": true, "type": "string" }, "type": "array" } }, "type": "object" } ], "description": "Filter definition type specified by label and values.", "required": [ "label", "values" ], "type": "object" }, "DependsOnDateFilter": { "allOf": [ { "$ref": "#/components/schemas/DependsOnItem" }, { "properties": { "dateFilter": { "$ref": "#/components/schemas/DateFilter" } }, "type": "object" } ], "description": "Filter definition type for dates.", "required": [ "dateFilter" ], "type": "object" }, "DependsOnItem": { "nullable": true, "type": "object" }, "Dimension": { "description": "Single dimension description.", "properties": { "itemIdentifiers": { "description": "List of items in current dimension. Can reference 'localIdentifier' from 'AttributeItem', or special pseudo attribute \"measureGroup\" representing list of metrics.", "example": [ "attribute_1", "measureGroup" ], "items": { "type": "string" }, "type": "array" }, "localIdentifier": { "description": "Dimension identification within requests. Other entities can reference this dimension by this value.", "example": "firstDimension", "pattern": "^[.a-zA-Z0-9_-]+$", "type": "string" }, "sorting": { "description": "List of sorting rules. From most relevant to least relevant (less relevant rule is applied, when more relevant rule compares items as equal).", "items": { "$ref": "#/components/schemas/SortKey" }, "type": "array" } }, "required": [ "itemIdentifiers" ], "type": "object" }, "DimensionHeader": { "description": "Contains the dimension-specific header information.", "properties": { "headerGroups": { "description": "An array containing header groups.", "items": { "$ref": "#/components/schemas/HeaderGroup" }, "type": "array" } }, "required": [ "headerGroups" ], "type": "object" }, "Element": { "description": "List of returned elements.", "properties": { "primaryTitle": { "description": "Title of primary label of attribute owning requested label, null if the title is null or the primary label is excluded", "type": "string" }, "title": { "description": "Title of requested label.", "type": "string" } }, "required": [ "primaryTitle", "title" ], "type": "object" }, "ElementsRequest": { "properties": { "complementFilter": { "default": false, "description": "Inverse filters:\n* ```false``` - return items matching ```patternFilter``` and ```exactFilter```\n* ```true``` - return items not matching ```patternFilter``` and ```exactFilter```", "type": "boolean" }, "dataSamplingPercentage": { "default": 100, "deprecated": true, "description": "Specifies percentage of source table data scanned during the computation. This field is deprecated and is no longer used during the elements computation.", "format": "float", "type": "number" }, "dependsOn": { "description": "Return only items, whose are not filtered out by the parent filters.", "items": { "oneOf": [ { "$ref": "#/components/schemas/DependsOn" }, { "$ref": "#/components/schemas/DependsOnDateFilter" } ] }, "type": "array" }, "exactFilter": { "description": "Return only items, whose ```label``` title exactly matches one of ```filter```.", "items": { "nullable": true, "type": "string" }, "type": "array" }, "excludePrimaryLabel": { "default": false, "description": "Excludes items from the result that differ only by primary label\n* ```false``` - return items with distinct primary label\n* ```true``` - return items with distinct requested label", "type": "boolean" }, "filterBy": { "$ref": "#/components/schemas/FilterBy" }, "label": { "description": "Requested label.", "example": "label_id", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "patternFilter": { "description": "Return only items, whose ```label``` title case insensitively contains ```filter``` as substring.", "type": "string" }, "sortOrder": { "description": "Sort order of returned items.\nItems are sorted by ```label``` title. If no sort order is specified then attribute's ```sortDirection``` is used, which is ASC by default", "enum": [ "ASC", "DESC" ], "type": "string" }, "validateBy": { "description": "Return only items, what are computable on metric.", "items": { "$ref": "#/components/schemas/ValidateByItem" }, "type": "array" } }, "required": [ "label" ], "type": "object" }, "ElementsResponse": { "description": "Entity holding list of sorted & filtered label elements, related primary label of attribute owning requested label and paging.", "properties": { "elements": { "description": "List of returned elements.", "items": { "$ref": "#/components/schemas/Element" }, "type": "array" }, "format": { "$ref": "#/components/schemas/AttributeFormat" }, "granularity": { "description": "Granularity of requested label in case of date attribute", "enum": [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR" ], "type": "string" }, "paging": { "$ref": "#/components/schemas/Paging" }, "primaryLabel": { "$ref": "#/components/schemas/RestApiIdentifier" } }, "required": [ "elements", "paging", "primaryLabel" ], "type": "object" }, "EntitlementsRequest": { "properties": { "entitlementsName": { "items": { "enum": [ "CacheStrategy", "Contract", "CustomTheming", "ExtraCache", "Hipaa", "PdfExports", "ManagedOIDC", "UiLocalization", "Tier", "UserCount", "UnlimitedUsers", "UnlimitedWorkspaces", "WhiteLabeling", "WorkspaceCount", "UserTelemetryDisabled" ], "type": "string" }, "type": "array", "uniqueItems": true } }, "required": [ "entitlementsName" ], "type": "object" }, "EntityIdentifier": { "properties": { "id": { "description": "Object identifier.", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "enum": [ "analyticalDashboard", "attribute", "dashboardPlugin", "dataset", "fact", "label", "metric", "userDataFilter", "prompt", "visualizationObject", "filterContext" ], "example": "metric", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "ExecutionLinks": { "properties": { "executionResult": { "type": "string" } }, "required": [ "executionResult" ], "type": "object" }, "ExecutionResponse": { "properties": { "dimensions": { "items": { "$ref": "#/components/schemas/ResultDimension" }, "type": "array" }, "links": { "$ref": "#/components/schemas/ExecutionLinks" } }, "required": [ "dimensions", "links" ], "type": "object" }, "ExecutionResult": { "description": "Contains the result of an AFM execution.", "properties": { "data": { "description": "A multi-dimensional array of computed results. The most common one being a 2-dimensional array. The arrays can be composed of Double or null values.", "example": [ [ 1, 2.5 ], [ -1.3, 3.14 ] ], "items": { "type": "object" }, "type": "array" }, "dimensionHeaders": { "description": "An array containing dimension headers. The size of the array corresponds to the number of dimensions. Their order corresponds to the dimension order in the execution result spec.", "items": { "$ref": "#/components/schemas/DimensionHeader" }, "type": "array" }, "grandTotals": { "items": { "$ref": "#/components/schemas/ExecutionResultGrandTotal" }, "type": "array" }, "paging": { "$ref": "#/components/schemas/ExecutionResultPaging" } }, "required": [ "data", "dimensionHeaders", "grandTotals", "paging" ], "type": "object" }, "ExecutionResultGrandTotal": { "description": "Contains the data of grand totals with the same dimensions.", "properties": { "data": { "description": "A multi-dimensional array of computed results. The most common one being a 2-dimensional array. The arrays can be composed of Double or null values.", "example": [ [ 1, 2.5 ], [ -1.3, 3.14 ] ], "items": { "type": "object" }, "type": "array" }, "dimensionHeaders": { "description": "Contains headers for a subset of `totalDimensions` in which the totals are grand totals.", "items": { "$ref": "#/components/schemas/DimensionHeader" }, "type": "array" }, "totalDimensions": { "description": "Dimensions of the grand totals.", "items": { "description": "Dimensions of the grand totals.", "type": "string" }, "type": "array" } }, "required": [ "data", "dimensionHeaders", "totalDimensions" ], "type": "object" }, "ExecutionResultHeader": { "description": "Abstract execution result header", "oneOf": [ { "$ref": "#/components/schemas/AttributeExecutionResultHeader" }, { "$ref": "#/components/schemas/MeasureExecutionResultHeader" }, { "$ref": "#/components/schemas/TotalExecutionResultHeader" } ], "type": "object" }, "ExecutionResultPaging": { "description": "A paging information related to the data presented in the execution result. These paging information are multi-dimensional.", "properties": { "count": { "description": "A count of the returned results in every dimension.", "example": [ 2, 2 ], "items": { "format": "int32", "type": "integer" }, "type": "array" }, "offset": { "description": "The offset of the results returned in every dimension.", "example": [ 0, 0 ], "items": { "format": "int32", "type": "integer" }, "type": "array" }, "total": { "description": "A total count of the results in every dimension.", "example": [ 2, 2 ], "items": { "format": "int32", "type": "integer" }, "type": "array" } }, "required": [ "count", "offset", "total" ], "type": "object" }, "ExecutionSettings": { "description": "Various settings affecting the process of AFM execution or its result", "properties": { "dataSamplingPercentage": { "description": "Specifies the percentage of rows from fact datasets to use during computation. This feature is available only for workspaces that use a Vertica Data Source without table views.", "exclusiveMaximum": true, "exclusiveMinimum": true, "format": "float", "maximum": 100, "minimum": 0, "type": "number" } }, "type": "object" }, "ExportResponse": { "properties": { "exportResult": { "type": "string" } }, "required": [ "exportResult" ], "type": "object" }, "FeatureFlagsContext": { "properties": { "earlyAccess": { "type": "string" } }, "required": [ "earlyAccess" ], "type": "object" }, "Features": { "description": "Base Structure for feature flags", "properties": { "context": { "$ref": "#/components/schemas/FeatureFlagsContext" } }, "required": [ "context" ], "type": "object" }, "File": { "properties": { "any": { "items": { "type": "object" }, "type": "array" }, "canResegment": { "enum": [ "YES", "NO" ], "type": "string", "xml": { "attribute": true } }, "id": { "type": "string", "xml": { "attribute": true } }, "notes": { "$ref": "#/components/schemas/Notes" }, "original": { "type": "string", "xml": { "attribute": true } }, "otherAttributes": { "additionalProperties": { "type": "string" }, "type": "object" }, "skeleton": { "$ref": "#/components/schemas/Skeleton" }, "space": { "type": "string", "xml": { "attribute": true, "namespace": "http://www.w3.org/XML/1998/namespace" } }, "srcDir": { "enum": [ "LTR", "RTL", "AUTO" ], "type": "string", "xml": { "attribute": true } }, "translate": { "enum": [ "YES", "NO" ], "type": "string", "xml": { "attribute": true } }, "trgDir": { "enum": [ "LTR", "RTL", "AUTO" ], "type": "string", "xml": { "attribute": true } }, "unitOrGroup": { "items": { "type": "object" }, "type": "array" } }, "type": "object", "xml": { "name": "file", "namespace": "urn:oasis:names:tc:xliff:document:2.0" } }, "FilterBy": { "description": "Specifies what is used for filtering.", "properties": { "labelType": { "default": "REQUESTED", "description": "Specifies which label is used for filtering - primary or requested.", "enum": [ "PRIMARY", "REQUESTED" ], "type": "string" } }, "type": "object" }, "FilterDefinition": { "description": "Abstract filter definition type", "oneOf": [ { "$ref": "#/components/schemas/InlineFilterDefinition" }, { "$ref": "#/components/schemas/RankingFilter" }, { "$ref": "#/components/schemas/ComparisonMeasureValueFilter" }, { "$ref": "#/components/schemas/RangeMeasureValueFilter" }, { "$ref": "#/components/schemas/AbsoluteDateFilter" }, { "$ref": "#/components/schemas/RelativeDateFilter" }, { "$ref": "#/components/schemas/NegativeAttributeFilter" }, { "$ref": "#/components/schemas/PositiveAttributeFilter" } ], "type": "object" }, "FilterDefinitionForSimpleMeasure": { "description": "Abstract filter definition type for simple metric.", "oneOf": [ { "$ref": "#/components/schemas/DateFilter" }, { "$ref": "#/components/schemas/AttributeFilter" } ], "type": "object" }, "GenerateLdmRequest": { "description": "A request containing all information needed for generation of logical model.", "properties": { "dateGranularities": { "description": "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).", "example": "all", "type": "string" }, "denormPrefix": { "description": "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.", "example": "dr", "type": "string" }, "factPrefix": { "description": "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.", "example": "f", "type": "string" }, "generateLongIds": { "description": "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 `