{ "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 the execution result.", "items": { "$ref": "#/components/schemas/FilterDefinition", "oneOf": [ { "$ref": "#/components/schemas/AbstractMeasureValueFilter" }, { "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" }, { "$ref": "#/components/schemas/InlineFilterDefinition" } ] }, "type": "array" }, "measureDefinitionOverrides": { "description": "(EXPERIMENTAL) Override definitions of catalog metrics for this request. Allows substituting a catalog metric's MAQL definition without modifying the stored definition.", "items": { "$ref": "#/components/schemas/MetricDefinitionOverride" }, "type": "array" }, "measures": { "description": "Metrics to be computed.", "items": { "$ref": "#/components/schemas/MeasureItem" }, "type": "array" }, "parameters": { "description": "(EXPERIMENTAL) Parameter values to use for this execution.", "items": { "$ref": "#/components/schemas/ParameterItem" }, "type": "array" } }, "required": [ "attributes", "filters", "measures" ], "type": "object" }, "AbsoluteDateFilter": { "additionalProperties": false, "description": "A datetime filter specifying exact from and to values.", "properties": { "absoluteDateFilter": { "$ref": "#/components/schemas/AbsoluteDateFilterBody", "properties": { "applyOnResult": { "type": "boolean" }, "dataset": { "$ref": "#/components/schemas/AfmObjectIdentifierDataset" }, "emptyValueHandling": { "default": "EXCLUDE", "description": "Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates.", "enum": [ "INCLUDE", "EXCLUDE", "ONLY" ], "type": "string" }, "from": { "example": "2020-07-01 18:23", "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", "type": "string" }, "localIdentifier": { "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": [ "dataset", "from", "to" ], "type": "object" } }, "required": [ "absoluteDateFilter" ], "title": "AbsoluteDateFilter", "type": "object" }, "AbsoluteDateFilterBody": { "additionalProperties": false, "properties": { "applyOnResult": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Applyonresult" }, "dataset": { "$ref": "#/components/schemas/AfmObjectIdentifier" }, "emptyValueHandling": { "anyOf": [ { "$ref": "#/components/schemas/EmptyValueHandling" }, { "type": "null" } ] }, "from": { "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", "title": "From", "type": "string" }, "localIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Localidentifier" }, "to": { "pattern": "^\\d{4}-\\d{1,2}-\\d{1,2}( \\d{1,2}:\\d{1,2})?$", "title": "To", "type": "string" } }, "required": [ "dataset", "from", "to" ], "title": "AbsoluteDateFilterBody", "type": "object" }, "AbstractMeasureValueFilter": { "oneOf": [ { "$ref": "#/components/schemas/ComparisonMeasureValueFilter" }, { "$ref": "#/components/schemas/RangeMeasureValueFilter" }, { "$ref": "#/components/schemas/CompoundMeasureValueFilter" }, { "$ref": "#/components/schemas/RankingFilter" } ], "type": "object" }, "ActiveObjectIdentification": { "description": "Object, with which the user is actively working.", "properties": { "id": { "description": "Object ID.", "title": "Id", "type": "string" }, "type": { "description": "Object type, e.g. dashboard.", "title": "Type", "type": "string" }, "workspaceId": { "description": "Workspace ID.", "title": "Workspaceid", "type": "string" } }, "required": [ "id", "type", "workspaceId" ], "title": "ActiveObjectIdentification", "type": "object" }, "AdHocAutomation": { "properties": { "alert": { "$ref": "#/components/schemas/AutomationAlert" }, "analyticalDashboard": { "$ref": "#/components/schemas/DeclarativeAnalyticalDashboardIdentifier" }, "dashboardTabularExports": { "items": { "$ref": "#/components/schemas/AutomationDashboardTabularExport" }, "type": "array", "uniqueItems": true }, "description": { "maxLength": 255, "type": "string" }, "details": { "additionalProperties": { "description": "Additional details to be included in the automated message.", "maxLength": 10000, "type": "string" }, "description": "Additional details to be included in the automated message.", "maxLength": 10000, "type": "object" }, "externalRecipients": { "description": "External recipients of the automation action results.", "items": { "$ref": "#/components/schemas/AutomationExternalRecipient" }, "type": "array", "uniqueItems": true }, "imageExports": { "items": { "$ref": "#/components/schemas/AutomationImageExport" }, "type": "array", "uniqueItems": true }, "metadata": { "$ref": "#/components/schemas/AutomationMetadata" }, "notificationChannel": { "$ref": "#/components/schemas/DeclarativeNotificationChannelIdentifier" }, "rawExports": { "items": { "$ref": "#/components/schemas/AutomationRawExport" }, "type": "array", "uniqueItems": true }, "recipients": { "items": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, "type": "array", "uniqueItems": true }, "slidesExports": { "items": { "$ref": "#/components/schemas/AutomationSlidesExport" }, "type": "array", "uniqueItems": true }, "tabularExports": { "items": { "$ref": "#/components/schemas/AutomationTabularExport" }, "type": "array", "uniqueItems": true }, "tags": { "description": "A list of tags.", "example": [ "Revenue", "Sales" ], "items": { "type": "string" }, "type": "array", "uniqueItems": true }, "title": { "maxLength": 255, "type": "string" }, "visualExports": { "items": { "$ref": "#/components/schemas/AutomationVisualExport" }, "type": "array", "uniqueItems": true } }, "type": "object" }, "AddDatabaseDataSourceRequest": { "description": "Request to add a data source to an AI Lake Database instance", "properties": { "dataSourceId": { "description": "Identifier for the new data source in metadata-api. Must be unique within the organization.", "type": "string" }, "dataSourceName": { "description": "Display name for the new data source in metadata-api. Defaults to dataSourceId when omitted.", "type": "string" } }, "required": [ "dataSourceId" ], "type": "object" }, "AddDatabaseDataSourceResponse": { "description": "Newly created data source association for an AI Lake Database instance", "properties": { "dataSource": { "$ref": "#/components/schemas/DataSourceInfo" } }, "required": [ "dataSource" ], "type": "object" }, "AfmCancelTokens": { "description": "Any information related to cancellation.", "properties": { "resultIdToCancelTokenPairs": { "additionalProperties": { "description": "resultId to cancel token pairs", "type": "string" }, "description": "resultId to cancel token pairs", "type": "object" } }, "required": [ "resultIdToCancelTokenPairs" ], "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": { "description": "Response to AFM execution request", "properties": { "executionResponse": { "$ref": "#/components/schemas/ExecutionResponse" } }, "required": [ "executionResponse" ], "type": "object" }, "AfmIdentifier": { "description": "Reference to the attribute label to which the filter should be applied.", "oneOf": [ { "$ref": "#/components/schemas/AfmObjectIdentifier" }, { "$ref": "#/components/schemas/AfmLocalIdentifier" } ], "type": "object" }, "AfmLocalIdentifier": { "additionalProperties": false, "description": "Local reference: ``{\"localIdentifier\": \"...\"}``.", "properties": { "localIdentifier": { "example": "sampleAutoGenerated0123_ID", "pattern": "^[.a-zA-Z0-9_-]+$", "title": "Localidentifier", "type": "string" } }, "required": [ "localIdentifier" ], "title": "AfmLocalIdentifier", "type": "object" }, "AfmObjectIdentifier": { "additionalProperties": false, "description": "ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers.", "properties": { "identifier": { "$ref": "#/components/schemas/AfmObjectIdentifierBody", "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" ], "title": "AfmObjectIdentifier", "type": "object" }, "AfmObjectIdentifierAttribute": { "description": "Reference to the date attribute to use.", "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" }, "AfmObjectIdentifierBody": { "additionalProperties": false, "properties": { "id": { "maxLength": 255, "minLength": 1, "title": "Id", "type": "string" }, "type": { "title": "Type", "type": "string" } }, "required": [ "id", "type" ], "title": "AfmObjectIdentifierBody", "type": "object" }, "AfmObjectIdentifierCore": { "description": "Reference to the metric, fact or attribute object to use for the metric.", "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": { "description": "Reference to the date dataset to which the filter should be applied.", "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" }, "AfmObjectIdentifierParameter": { "description": "Reference to the parameter.", "properties": { "identifier": { "properties": { "id": { "example": "sample_item.price", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "enum": [ "parameter" ], "type": "string" } }, "required": [ "id", "type" ], "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" }, "AgentListItemResponse": { "description": "A single agent visible to the calling user in the workspace.", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "title": "Id", "type": "string" }, "isAvailableToAll": { "title": "Isavailabletoall", "type": "boolean" }, "lastUsedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Lastusedat" }, "modifiedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Modifiedat" }, "name": { "title": "Name", "type": "string" } }, "required": [ "id", "name", "isAvailableToAll" ], "title": "AgentListItemResponse", "type": "object" }, "AgentListResponse": { "description": "List of agents accessible to the calling user.", "properties": { "agents": { "items": { "$ref": "#/components/schemas/AgentListItemResponse" }, "title": "Agents", "type": "array" } }, "required": [ "agents" ], "title": "AgentListResponse", "type": "object" }, "AggregateKeyConfig": { "description": "Aggregate key model \u2014 pre-aggregates rows sharing the same key columns.", "properties": { "columns": { "description": "Key columns. Defaults to first inferred column.", "items": { "description": "Key columns. Defaults to first inferred column.", "type": "string" }, "type": "array" } }, "type": "object" }, "AiUsageMetadataItem": { "description": "AI usage metadata returned after the interaction (e.g. current query count vs. entitlement limit).", "properties": { "counterType": { "description": "Type of usage counter, e.g. AI_QUERIES.", "type": "string" }, "currentValue": { "description": "Current usage value after this request.", "format": "int64", "type": "integer" }, "limit": { "description": "Entitlement limit. 0 means unlimited.", "format": "int64", "type": "integer" } }, "required": [ "counterType", "currentValue", "limit" ], "type": "object" }, "AlertAfm": { "properties": { "attributes": { "description": "Attributes to be used in the computation.", "items": { "$ref": "#/components/schemas/AttributeItem" }, "maximum": 1, "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. For anomaly detection, exactly one dataset is specified in the condition. The AFM may contain multiple date filters for different datasets, but only the date filter matching the dataset from the condition is used for anomaly detection.", "items": { "$ref": "#/components/schemas/FilterDefinition" }, "type": "array" }, "measures": { "description": "Metrics to be computed. One metric if the alert condition is evaluated to a scalar. Two metrics when they should be evaluated to each other.", "items": { "$ref": "#/components/schemas/MeasureItem" }, "maximum": 2, "minimum": 1, "type": "array" }, "parameters": { "description": "Parameters to be used in the computation.", "items": { "$ref": "#/components/schemas/ParameterItem" }, "type": "array" } }, "required": [ "filters", "measures" ], "type": "object" }, "AlertCondition": { "description": "Alert trigger condition.", "oneOf": [ { "$ref": "#/components/schemas/ComparisonWrapper" }, { "$ref": "#/components/schemas/RangeWrapper" }, { "$ref": "#/components/schemas/RelativeWrapper" }, { "$ref": "#/components/schemas/AnomalyDetectionWrapper" } ], "type": "object" }, "AlertConditionOperand": { "description": "Operand of the alert condition.", "oneOf": [ { "$ref": "#/components/schemas/LocalIdentifier" }, { "$ref": "#/components/schemas/Value" } ], "type": "object" }, "AlertDatasetIdentifier": { "additionalProperties": false, "properties": { "id": { "description": "Date dataset identifier.", "title": "Id", "type": "string" }, "type": { "const": "dataset", "default": "dataset", "description": "Dataset object type.", "title": "Type", "type": "string" } }, "required": [ "id" ], "title": "AlertDatasetIdentifier", "type": "object" }, "AlertDatasetRef": { "additionalProperties": false, "properties": { "identifier": { "$ref": "#/components/schemas/AlertDatasetIdentifier", "description": "Date dataset identifier." }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Date dataset display title.", "title": "Title" } }, "required": [ "identifier" ], "title": "AlertDatasetRef", "type": "object" }, "AlertDefinition": { "additionalProperties": false, "description": "The alert itself (mirrors canonical AutomationAlert).", "properties": { "condition": { "description": "Alert trigger condition.", "oneOf": [ { "$ref": "#/components/schemas/ComparisonCondition" }, { "$ref": "#/components/schemas/RangeCondition" }, { "$ref": "#/components/schemas/RelativeCondition" }, { "$ref": "#/components/schemas/AnomalyCondition" } ], "title": "Condition" }, "execution": { "$ref": "#/components/schemas/AlertExecution", "description": "Execution (AFM) definition of the alert." }, "interval": { "anyOf": [ { "$ref": "#/components/schemas/IntervalGranularity" }, { "type": "null" } ], "description": "Interval granularity for ONCE_PER_INTERVAL triggers." }, "trigger": { "$ref": "#/components/schemas/AlertTrigger", "default": "ALWAYS", "description": "Trigger behavior." } }, "required": [ "execution", "condition" ], "title": "AlertDefinition", "type": "object" }, "AlertDescription": { "properties": { "attribute": { "type": "string" }, "condition": { "type": "string" }, "currentValues": { "items": { "$ref": "#/components/schemas/AlertEvaluationRow" }, "type": "array" }, "errorMessage": { "type": "string" }, "formattedThreshold": { "type": "string" }, "lowerThreshold": { "format": "double", "type": "number" }, "metric": { "type": "string" }, "remainingAlertEvaluationCount": { "format": "int32", "type": "integer" }, "status": { "enum": [ "SUCCESS", "ERROR", "INTERNAL_ERROR", "TIMEOUT" ], "type": "string" }, "threshold": { "format": "double", "type": "number" }, "totalValueCount": { "format": "int32", "type": "integer" }, "traceId": { "type": "string" }, "triggeredAt": { "format": "date-time", "type": "string" }, "triggeredCount": { "format": "int32", "type": "integer" }, "upperThreshold": { "format": "double", "type": "number" } }, "required": [ "condition", "metric" ], "type": "object" }, "AlertEvaluationRow": { "properties": { "computedMetric": { "$ref": "#/components/schemas/MetricRecord" }, "labelValue": { "type": "string" }, "primaryMetric": { "$ref": "#/components/schemas/MetricRecord" }, "secondaryMetric": { "$ref": "#/components/schemas/MetricRecord" } }, "type": "object" }, "AlertExecution": { "additionalProperties": false, "description": "Execution definition (AFM) of the alert.\n\n``measures`` / ``attributes`` / ``filters`` are opaque AFM wire objects (same\ntreatment as ``KeyDriverAnalysis.filters``); the semantic typing the FE renders\nlives on the typed ``condition`` union.", "properties": { "attributes": { "description": "Attribute slicing configuration.", "items": { "additionalProperties": true, "type": "object" }, "title": "Attributes", "type": "array" }, "filters": { "description": "Alert execution filters.", "items": { "additionalProperties": true, "type": "object" }, "title": "Filters", "type": "array" }, "measures": { "description": "Metrics computed by the alert (1-2).", "items": { "additionalProperties": true, "type": "object" }, "title": "Measures", "type": "array" } }, "title": "AlertExecution", "type": "object" }, "AlertProposal": { "additionalProperties": false, "description": "Structured pre-creation alert proposal \u2014 the single model used as the HTTP DTO,\nthe persisted shape, and the in-memory conversation-state object.", "properties": { "alert": { "$ref": "#/components/schemas/AlertDefinition", "description": "The alert definition (condition, execution, trigger)." }, "automationId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Automation identifier proposed for creation.", "title": "Automationid" }, "cta": { "default": "Should I create this alert?", "description": "Confirmation call to action.", "title": "Cta", "type": "string" }, "dashboard": { "anyOf": [ { "$ref": "#/components/schemas/DashboardRef" }, { "type": "null" } ], "description": "Dashboard the alert is bound to." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Alert description.", "title": "Description" }, "forLabel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Human-readable 'For' summary.", "title": "Forlabel" }, "forMode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Display mode for the monitored population.", "title": "Formode" }, "notificationChannel": { "$ref": "#/components/schemas/NotificationChannelRef", "description": "Notification channel for delivery." }, "recipients": { "description": "Recipients shown in the proposal.", "items": { "$ref": "#/components/schemas/AlertRecipient" }, "title": "Recipients", "type": "array" }, "schedule": { "anyOf": [ { "$ref": "#/components/schemas/AlertSchedule" }, { "type": "null" } ], "description": "Optional cron schedule." }, "title": { "description": "Alert title.", "title": "Title", "type": "string" } }, "required": [ "title", "alert", "notificationChannel" ], "title": "AlertProposal", "type": "object" }, "AlertProposalPart": { "additionalProperties": false, "properties": { "alertProposal": { "anyOf": [ { "$ref": "#/components/schemas/AlertProposal" }, { "type": "null" } ], "description": "Optional full alert proposal payload when available." }, "type": { "const": "alertProposal", "default": "alertProposal", "description": "Type of multipart part.", "title": "Type", "type": "string" } }, "title": "AlertProposalPart", "type": "object" }, "AlertRecipient": { "additionalProperties": false, "properties": { "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "External recipient email when available.", "title": "Email" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Internal user identifier when available.", "title": "Id" }, "label": { "description": "Recipient display label.", "title": "Label", "type": "string" } }, "required": [ "label" ], "title": "AlertRecipient", "type": "object" }, "AlertSchedule": { "additionalProperties": false, "properties": { "cron": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cron expression for the alert schedule.", "title": "Cron" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Schedule timezone.", "title": "Timezone" } }, "title": "AlertSchedule", "type": "object" }, "AlertTrigger": { "description": "Trigger behavior for the alert.", "enum": [ "ALWAYS", "ONCE", "ONCE_PER_INTERVAL" ], "title": "AlertTrigger", "type": "string" }, "AllTimeDateFilter": { "description": "An all-time date filter that does not restrict by date range. Controls how rows with empty (null/missing) date values are handled.", "properties": { "allTimeDateFilter": { "properties": { "applyOnResult": { "type": "boolean" }, "dataset": { "$ref": "#/components/schemas/AfmObjectIdentifierDataset" }, "emptyValueHandling": { "default": "INCLUDE", "description": "Specifies how rows with empty (null/missing) date values should be handled. INCLUDE means no filtering effect (default), EXCLUDE removes rows with null dates, ONLY keeps only rows with null dates.", "enum": [ "INCLUDE", "EXCLUDE", "ONLY" ], "type": "string" }, "granularity": { "default": "DAY", "description": "Date granularity used to resolve the date attribute label for null value checks. Defaults to DAY if not specified.", "enum": [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR" ], "example": "DAY", "type": "string" }, "localIdentifier": { "type": "string" } }, "required": [ "dataset" ], "type": "object" } }, "required": [ "allTimeDateFilter" ], "type": "object" }, "AllTimeDateFilter-Input": { "additionalProperties": false, "properties": { "allTimeDateFilter": { "$ref": "#/components/schemas/AllTimeDateFilterBody-Input" } }, "required": [ "allTimeDateFilter" ], "title": "AllTimeDateFilter", "type": "object" }, "AllTimeDateFilter-Output": { "additionalProperties": false, "properties": { "allTimeDateFilter": { "$ref": "#/components/schemas/AllTimeDateFilterBody-Output" } }, "required": [ "allTimeDateFilter" ], "title": "AllTimeDateFilter", "type": "object" }, "AllTimeDateFilterBody-Input": { "additionalProperties": false, "properties": { "applyOnResult": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Applyonresult" }, "dataset": { "$ref": "#/components/schemas/AfmObjectIdentifier" }, "emptyValueHandling": { "anyOf": [ { "$ref": "#/components/schemas/EmptyValueHandling" }, { "type": "null" } ] }, "granularity": { "anyOf": [ { "$ref": "#/components/schemas/DateGranularity-Input" }, { "type": "null" } ] }, "localIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Localidentifier" } }, "required": [ "dataset" ], "title": "AllTimeDateFilterBody", "type": "object" }, "AllTimeDateFilterBody-Output": { "additionalProperties": false, "properties": { "applyOnResult": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Applyonresult" }, "dataset": { "$ref": "#/components/schemas/AfmObjectIdentifier" }, "emptyValueHandling": { "anyOf": [ { "$ref": "#/components/schemas/EmptyValueHandling" }, { "type": "null" } ] }, "granularity": { "anyOf": [ { "$ref": "#/components/schemas/app__application__dtos__afm__filter_definition__DateGranularity" }, { "type": "null" } ] }, "localIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Localidentifier" } }, "required": [ "dataset" ], "title": "AllTimeDateFilterBody", "type": "object" }, "AllowedRelationshipType": { "description": "Allowed relationship type combination.", "properties": { "allowOrphans": { "default": true, "description": "If true, allows target objects that are not part of any relationship (orphans) to be included in results. If false, orphan target objects will be excluded even if they directly match the search query. Default is true (orphans are allowed).", "title": "Alloworphans", "type": "boolean" }, "sourceType": { "description": "Source object type (e.g., 'dashboard', 'visualization', 'metric').", "enum": [ "attribute", "metric", "fact", "label", "date", "dataset", "visualization", "dashboard" ], "title": "Sourcetype", "type": "string" }, "targetType": { "description": "Target object type (e.g., 'visualization', 'metric', 'attribute').", "enum": [ "attribute", "metric", "fact", "label", "date", "dataset", "visualization", "dashboard" ], "title": "Targettype", "type": "string" } }, "required": [ "sourceType", "targetType" ], "title": "AllowedRelationshipType", "type": "object" }, "AmplitudeService": { "description": "Amplitude service.", "properties": { "aiProjectApiKey": { "description": "API key for AI project - intended for frontend use.", "type": "string" }, "endpoint": { "description": "Amplitude endpoint URL.", "type": "string" }, "gdCommonApiKey": { "description": "API key for GoodData common project - used by backend.", "type": "string" }, "reportingEndpoint": { "description": "Optional reporting endpoint for proxying telemetry events.", "type": "string" } }, "required": [ "aiProjectApiKey", "endpoint", "gdCommonApiKey" ], "type": "object" }, "AnalyticsCatalogCreatedBy": { "description": "List of users who created catalog objects in the workspace hierarchy.", "properties": { "reasoning": { "description": "Reserved for future use. Always empty string in the current implementation.", "type": "string" }, "users": { "description": "Distinct users who have created at least one catalog object.", "items": { "$ref": "#/components/schemas/AnalyticsCatalogUser" }, "type": "array" } }, "required": [ "reasoning", "users" ], "type": "object" }, "AnalyticsCatalogTags": { "description": "List of distinct catalog tags aggregated across the workspace hierarchy.", "properties": { "tags": { "description": "Sorted, distinct tag strings found in the workspace hierarchy.", "items": { "type": "string" }, "type": "array" } }, "required": [ "tags" ], "type": "object" }, "AnalyticsCatalogUser": { "description": "A user who has created one or more catalog objects.", "properties": { "firstname": { "description": "User first name.", "example": "John", "type": "string" }, "lastname": { "description": "User last name.", "example": "Doe", "type": "string" }, "userId": { "description": "User identifier.", "example": "user123", "type": "string" } }, "required": [ "firstname", "lastname", "userId" ], "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" }, "headerRowCount": { "description": "Number of rows to consider as header, if null, header will be detected.", "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" }, "AnalyzeStatisticsRequest": { "description": "Request to run ANALYZE TABLE for tables in a database instance", "properties": { "tableNames": { "description": "Table names to analyze. If empty or null, all tables in the database are analyzed.", "items": { "description": "Table names to analyze. If empty or null, all tables in the database are analyzed.", "type": "string" }, "type": "array" } }, "type": "object" }, "AnomalyCondition": { "additionalProperties": false, "properties": { "anomaly": { "$ref": "#/components/schemas/AnomalyDetection", "description": "Anomaly detection condition." } }, "required": [ "anomaly" ], "title": "AnomalyCondition", "type": "object" }, "AnomalyDetection": { "additionalProperties": false, "properties": { "dataset": { "$ref": "#/components/schemas/AfmObjectIdentifierDataset", "description": "Date dataset used for anomaly detection." }, "granularity": { "$ref": "#/components/schemas/AnomalyDetectionGranularity", "description": "Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR).", "enum": [ "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ], "type": "string" }, "measure": { "$ref": "#/components/schemas/LocalIdentifier", "description": "Metric analyzed for anomalies." }, "sensitivity": { "$ref": "#/components/schemas/Sensitivity", "description": "Sensitivity level for anomaly detection", "enum": [ "LOW", "MEDIUM", "HIGH" ], "type": "string" } }, "required": [ "dataset", "granularity", "measure", "sensitivity" ], "title": "AnomalyDetection", "type": "object" }, "AnomalyDetectionConfig": { "description": "Anomaly detection configuration.", "properties": { "sensitivity": { "description": "Outlier sensitivity level.", "enum": [ "LOW", "MEDIUM", "HIGH" ], "type": "string" } }, "required": [ "sensitivity" ], "type": "object" }, "AnomalyDetectionGranularity": { "description": "Time-based granularity supported by anomaly detection.", "enum": [ "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ], "title": "AnomalyDetectionGranularity", "type": "string" }, "AnomalyDetectionRequest": { "properties": { "sensitivity": { "description": "Anomaly detection sensitivity.", "format": "float", "type": "number" } }, "required": [ "sensitivity" ], "type": "object" }, "AnomalyDetectionResult": { "properties": { "anomalyFlag": { "items": { "nullable": true, "type": "boolean" }, "type": "array" }, "attribute": { "items": { "type": "string" }, "type": "array" }, "values": { "items": { "nullable": true, "type": "number" }, "type": "array" } }, "required": [ "anomalyFlag", "attribute", "values" ], "type": "object" }, "AnomalyDetectionWrapper": { "properties": { "anomaly": { "$ref": "#/components/schemas/AnomalyDetection" } }, "required": [ "anomaly" ], "type": "object" }, "AnthropicApiKeyAuth": { "allOf": [ { "properties": { "apiKey": { "description": "Anthropic API key.", "maxLength": 255, "nullable": true, "type": "string", "writeOnly": true }, "type": { "description": "Authentication type.", "enum": [ "API_KEY" ], "type": "string" } }, "type": "object" } ], "required": [ "type" ], "type": "object" }, "AnthropicProviderAuth": { "description": "Authentication configuration.", "oneOf": [ { "$ref": "#/components/schemas/AnthropicApiKeyAuth" } ], "type": "object" }, "AnthropicProviderConfig": { "description": "Configuration for Anthropic provider.", "properties": { "auth": { "$ref": "#/components/schemas/AnthropicProviderAuth" }, "baseUrl": { "default": "https://api.anthropic.com", "description": "Custom base URL for the Anthropic API. Defaults to the official endpoint; override only for enterprise proxies or compatible gateways.", "maxLength": 255, "type": "string" }, "type": { "description": "Provider type.", "enum": [ "ANTHROPIC" ], "type": "string" } }, "required": [ "auth", "type" ], "type": "object" }, "ApiEntitlement": { "description": "Defines entitlements for given organization.", "properties": { "expiry": { "format": "date", "type": "string" }, "name": { "enum": [ "CacheStrategy", "Contract", "CustomTheming", "ExtraCache", "Hipaa", "PdfExports", "UiLocalization", "Tier", "UserCount", "ManagedIdpUserCount", "UnlimitedUsers", "UnlimitedWorkspaces", "WhiteLabeling", "WorkspaceCount", "UserTelemetryDisabled", "AutomationCount", "UnlimitedAutomations", "AutomationRecipientCount", "UnlimitedAutomationRecipients", "DailyScheduledActionCount", "UnlimitedDailyScheduledActions", "DailyAlertActionCount", "UnlimitedDailyAlertActions", "ScheduledActionMinimumRecurrenceMinutes", "FederatedIdentityManagement", "AuditLogging", "ControlledFeatureRollout", "AiLake", "AiModule", "AiQueryLimit", "AiKnowledgeStorageLimit", "AiAgentLimit", "AiWorkspaceLimit", "AiObservability" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "ArithmeticMeasure": { "additionalProperties": false, "properties": { "left": { "$ref": "#/components/schemas/LocalIdentifier", "description": "First metric." }, "operator": { "$ref": "#/components/schemas/ArithmeticOperator", "description": "Arithmetic operator.\nDIFFERENCE - m\u2081\u2212m\u2082 - the difference between two metrics.\nCHANGE - (m\u2081\u2212m\u2082)\u00f7m\u2082 - the relative difference between two metrics.\n", "enum": [ "DIFFERENCE", "CHANGE" ], "type": "string" }, "right": { "$ref": "#/components/schemas/LocalIdentifier", "description": "Second metric." } }, "required": [ "left", "operator", "right" ], "title": "ArithmeticMeasure", "type": "object" }, "ArithmeticMeasureDefinition": { "description": "Metric representing arithmetics between other 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" }, "ArithmeticOperator": { "description": "Arithmetic operator between two metrics of a relative condition.", "enum": [ "DIFFERENCE", "CHANGE" ], "title": "ArithmeticOperator", "type": "string" }, "AssigneeIdentifier": { "description": "Identifier of a user or user-group.", "properties": { "id": { "description": "Identifier of the assignee.", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "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" }, "AttributeElements": { "oneOf": [ { "$ref": "#/components/schemas/AttributeElementsByRef" }, { "$ref": "#/components/schemas/AttributeElementsByValue" } ], "type": "object" }, "AttributeElementsByRef": { "properties": { "uris": { "description": "List of attribute elements by reference", "items": { "nullable": true, "type": "string" }, "type": "array" } }, "required": [ "uris" ], "type": "object" }, "AttributeElementsByValue": { "properties": { "values": { "description": "List of attribute elements by value", "items": { "nullable": true, "type": "string" }, "type": "array" } }, "required": [ "values" ], "type": "object" }, "AttributeExecutionResultHeader": { "properties": { "attributeHeader": { "$ref": "#/components/schemas/AttributeResultHeader" } }, "required": [ "attributeHeader" ], "type": "object" }, "AttributeFilter": { "additionalProperties": false, "description": "Abstract filter definition type attributes", "oneOf": [ { "$ref": "#/components/schemas/NegativeAttributeFilter" }, { "$ref": "#/components/schemas/PositiveAttributeFilter" }, { "$ref": "#/components/schemas/MatchAttributeFilter" } ], "properties": { "state": { "$ref": "#/components/schemas/AttributeFilterState" }, "type": { "const": "attribute_filter", "title": "Type", "type": "string" }, "using": { "title": "Using", "type": "string" } }, "required": [ "type", "using", "state" ], "title": "AttributeFilter", "type": "object" }, "AttributeFilterByDate": { "properties": { "filterLocalIdentifier": { "type": "string" }, "isCommonDate": { "type": "boolean" } }, "required": [ "filterLocalIdentifier", "isCommonDate" ], "type": "object" }, "AttributeFilterElements": { "additionalProperties": false, "description": "Filter on specific set of label values.", "properties": { "values": { "description": "Set of label values.", "example": [ "value1", "value2" ], "items": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "nullable": true, "type": "string" }, "title": "Values", "type": "array", "uniqueItems": true } }, "required": [ "values" ], "title": "AttributeFilterElements", "type": "object" }, "AttributeFilterParent": { "properties": { "filterLocalIdentifier": { "type": "string" }, "over": { "$ref": "#/components/schemas/Over" } }, "required": [ "filterLocalIdentifier", "over" ], "type": "object" }, "AttributeFilterState": { "additionalProperties": false, "properties": { "exclude": { "items": { "type": "string" }, "title": "Exclude", "type": "array" }, "include": { "items": { "type": "string" }, "title": "Include", "type": "array" } }, "title": "AttributeFilterState", "type": "object" }, "AttributeFormat": { "description": "Attribute format describes formatting information to effectively format attribute values when needed.", "properties": { "locale": { "description": "Format locale code like 'en-US', 'cs-CZ', etc.", "type": "string" }, "pattern": { "description": "ICU formatting pattern like 'y', 'dd.MM.y', etc.", "type": "string" }, "timezone": { "description": "Timezone for date formatting like 'America/New_York', 'Europe/Prague', etc.", "type": "string" } }, "required": [ "locale", "pattern" ], "type": "object" }, "AttributeHeader": { "properties": { "attributeHeader": { "properties": { "attribute": { "$ref": "#/components/schemas/RestApiIdentifier" }, "attributeName": { "description": "Attribute name.", "type": "string" }, "format": { "$ref": "#/components/schemas/AttributeFormat" }, "geoAreaConfig": { "$ref": "#/components/schemas/GeoAreaConfig" }, "granularity": { "description": "Date granularity of the attribute, only filled for date attributes.", "enum": [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR" ], "type": "string" }, "label": { "$ref": "#/components/schemas/RestApiIdentifier" }, "labelName": { "description": "Label name.", "type": "string" }, "localIdentifier": { "description": "Local identifier of the attribute this header relates to.", "pattern": "^[.a-zA-Z0-9_-]+$", "type": "string" }, "primaryLabel": { "$ref": "#/components/schemas/RestApiIdentifier" }, "valueType": { "description": "Attribute value type.", "enum": [ "TEXT", "HYPERLINK", "GEO", "GEO_LONGITUDE", "GEO_LATITUDE", "GEO_AREA", "GEO_ICON", "IMAGE", "HYPERLOGLOG" ], "type": "string" } }, "required": [ "attribute", "attributeName", "label", "labelName", "localIdentifier", "primaryLabel" ], "type": "object" } }, "required": [ "attributeHeader" ], "type": "object" }, "AttributeItem": { "properties": { "label": { "$ref": "#/components/schemas/AfmObjectIdentifierLabel" }, "localIdentifier": { "description": "Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.", "example": "attribute_1", "pattern": "^[.a-zA-Z0-9_-]+$", "type": "string" }, "showAllValues": { "default": false, "description": "Indicates whether to show all values of given attribute even if the data bound to those values is not available.", "type": "boolean" } }, "required": [ "label", "localIdentifier" ], "type": "object" }, "AttributeNegativeFilter": { "allOf": [ { "$ref": "#/components/schemas/Filter" }, { "properties": { "exclude": { "items": { "type": "string" }, "type": "array" }, "using": { "type": "string" } }, "type": "object" } ], "required": [ "exclude", "using" ], "type": "object" }, "AttributePositiveFilter": { "allOf": [ { "$ref": "#/components/schemas/Filter" }, { "properties": { "include": { "items": { "type": "string" }, "type": "array" }, "using": { "type": "string" } }, "type": "object" } ], "required": [ "include", "using" ], "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" }, "AttributeSortItem": { "additionalProperties": false, "properties": { "aggregation": { "const": "SUM", "title": "Aggregation", "type": "string" }, "by": { "title": "By", "type": "string" }, "direction": { "enum": [ "ASC", "DESC" ], "title": "Direction", "type": "string" }, "type": { "const": "attribute_sort", "title": "Type", "type": "string" } }, "required": [ "type", "by", "direction" ], "title": "AttributeSortItem", "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" }, "AutomationAlert": { "properties": { "condition": { "oneOf": [ { "$ref": "#/components/schemas/AnomalyDetectionWrapper" }, { "$ref": "#/components/schemas/ComparisonWrapper" }, { "$ref": "#/components/schemas/RangeWrapper" }, { "$ref": "#/components/schemas/RelativeWrapper" } ] }, "execution": { "$ref": "#/components/schemas/AlertAfm" }, "interval": { "description": "Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ], "type": "string" }, "trigger": { "default": "ALWAYS", "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\nONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS.\n", "enum": [ "ALWAYS", "ONCE", "ONCE_PER_INTERVAL" ], "type": "string" } }, "required": [ "condition", "execution" ], "type": "object" }, "AutomationDashboardTabularExport": { "properties": { "requestPayload": { "$ref": "#/components/schemas/DashboardTabularExportRequestV2" } }, "required": [ "requestPayload" ], "type": "object" }, "AutomationExternalRecipient": { "properties": { "email": { "description": "E-mail address to send notifications from.", "format": "email", "type": "string" } }, "required": [ "email" ], "type": "object" }, "AutomationImageExport": { "properties": { "requestPayload": { "$ref": "#/components/schemas/ImageExportRequest" } }, "required": [ "requestPayload" ], "type": "object" }, "AutomationMetadata": { "additionalProperties": true, "description": "Additional information for the automation.", "maxLength": 250000, "nullable": true, "properties": { "visibleFilters": { "items": { "$ref": "#/components/schemas/VisibleFilter" }, "type": "array" }, "widget": { "type": "string" } }, "type": "object" }, "AutomationNotification": { "allOf": [ { "$ref": "#/components/schemas/NotificationContent" }, { "properties": { "content": { "$ref": "#/components/schemas/WebhookMessage" } }, "type": "object" } ], "required": [ "content" ], "type": "object" }, "AutomationRawExport": { "properties": { "requestPayload": { "$ref": "#/components/schemas/RawExportAutomationRequest" } }, "required": [ "requestPayload" ], "type": "object" }, "AutomationSchedule": { "properties": { "cron": { "description": "Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.", "example": "0 */30 9-17 ? * MON-FRI", "maxLength": 255, "type": "string" }, "cronDescription": { "description": "Human-readable description of the cron expression.", "readOnly": true, "type": "string" }, "firstRun": { "description": "Timestamp of the first scheduled action. If not provided default to the next scheduled time.", "example": "2025-01-01T12:00:00Z", "format": "date-time", "type": "string" }, "timezone": { "description": "Timezone in which the schedule is defined.", "example": "Europe/Prague", "maxLength": 255, "type": "string" } }, "required": [ "cron", "timezone" ], "type": "object" }, "AutomationSlidesExport": { "properties": { "requestPayload": { "$ref": "#/components/schemas/SlidesExportRequest" } }, "required": [ "requestPayload" ], "type": "object" }, "AutomationTabularExport": { "properties": { "requestPayload": { "$ref": "#/components/schemas/TabularExportRequest" } }, "required": [ "requestPayload" ], "type": "object" }, "AutomationVisualExport": { "properties": { "requestPayload": { "$ref": "#/components/schemas/VisualExportRequest" } }, "required": [ "requestPayload" ], "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" }, "AwsBedrockAccessKeyAuth": { "allOf": [ { "properties": { "accessKeyId": { "description": "AWS Access Key ID.", "maxLength": 255, "nullable": true, "type": "string", "writeOnly": true }, "secretAccessKey": { "description": "AWS Secret Access Key.", "maxLength": 10000, "nullable": true, "type": "string", "writeOnly": true }, "sessionToken": { "description": "AWS Session Token (for temporary credentials).", "maxLength": 10000, "nullable": true, "type": "string", "writeOnly": true }, "type": { "description": "Authentication type.", "enum": [ "ACCESS_KEY" ], "type": "string" } }, "type": "object" } ], "required": [ "type" ], "type": "object" }, "AwsBedrockProviderConfig": { "description": "Configuration for AWS Bedrock provider.", "properties": { "auth": { "$ref": "#/components/schemas/BedrockProviderAuth" }, "region": { "description": "AWS region for Bedrock.", "example": "us-east-1", "maxLength": 255, "type": "string" }, "type": { "description": "Provider type.", "enum": [ "AWS_BEDROCK" ], "type": "string" } }, "required": [ "auth", "region", "type" ], "type": "object" }, "AzureFoundryApiKeyAuth": { "allOf": [ { "properties": { "apiKey": { "description": "Azure API key.", "maxLength": 255, "nullable": true, "type": "string", "writeOnly": true }, "type": { "description": "Authentication type.", "enum": [ "API_KEY" ], "type": "string" } }, "type": "object" } ], "required": [ "type" ], "type": "object" }, "AzureFoundryProviderAuth": { "description": "Authentication configuration.", "oneOf": [ { "$ref": "#/components/schemas/AzureFoundryApiKeyAuth" } ], "type": "object" }, "AzureFoundryProviderConfig": { "description": "Configuration for Azure Foundry provider.", "properties": { "auth": { "$ref": "#/components/schemas/AzureFoundryProviderAuth" }, "endpoint": { "description": "Azure OpenAI endpoint URL.", "example": "https://my-resource.openai.azure.com", "maxLength": 255, "type": "string" }, "type": { "description": "Provider type.", "enum": [ "AZURE_FOUNDRY" ], "type": "string" } }, "required": [ "auth", "endpoint", "type" ], "type": "object" }, "BedrockProviderAuth": { "description": "Authentication configuration.", "oneOf": [ { "$ref": "#/components/schemas/AwsBedrockAccessKeyAuth" } ], "type": "object" }, "BoundedFilter": { "description": "Bounding filter for this relative date filter. This can be used to limit the range of the relative date filter to a specific date range.", "properties": { "from": { "description": "Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago'). If null, then start of the range is unbounded.", "example": -6, "format": "int32", "nullable": true, "type": "integer" }, "granularity": { "description": "Date granularity specifying particular date attribute in given dimension.", "enum": [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR" ], "example": "DAY", "type": "string" }, "to": { "description": "End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...). If null, then end of the range is unbounded.", "example": 0, "format": "int32", "nullable": true, "type": "integer" } }, "required": [ "granularity" ], "type": "object" }, "BoundedFilter-Input": { "additionalProperties": false, "properties": { "from": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "From" }, "granularity": { "$ref": "#/components/schemas/DateGranularity-Input" }, "to": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "To" } }, "required": [ "granularity" ], "title": "BoundedFilter", "type": "object" }, "BoundedFilter-Output": { "additionalProperties": false, "properties": { "from": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "From" }, "granularity": { "$ref": "#/components/schemas/app__application__dtos__afm__filter_definition__DateGranularity" }, "to": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "To" } }, "required": [ "granularity" ], "title": "BoundedFilter", "type": "object" }, "BucketRefObject": { "additionalProperties": false, "properties": { "field": { "title": "Field", "type": "string" } }, "required": [ "field" ], "title": "BucketRefObject", "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" }, "ChangeAnalysisParams": { "description": "Change analysis specification.", "properties": { "analyzedPeriod": { "description": "The analyzed time period", "type": "string" }, "attributes": { "description": "Attributes to analyze for significant changes", "items": { "$ref": "#/components/schemas/AttributeItem" }, "type": "array" }, "dateAttribute": { "$ref": "#/components/schemas/AttributeItem" }, "filters": { "description": "Optional filters to apply", "items": { "oneOf": [ { "$ref": "#/components/schemas/AbstractMeasureValueFilter" }, { "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" }, { "$ref": "#/components/schemas/InlineFilterDefinition" } ] }, "type": "array" }, "measure": { "$ref": "#/components/schemas/MeasureItem" }, "measureTitle": { "description": "The title of the measure being analyzed", "type": "string" }, "referencePeriod": { "description": "The reference time period", "type": "string" }, "useSmartAttributeSelection": { "description": "Whether to use smart attribute selection", "type": "boolean" } }, "required": [ "analyzedPeriod", "attributes", "dateAttribute", "filters", "measure", "measureTitle", "referencePeriod", "useSmartAttributeSelection" ], "type": "object" }, "ChangeAnalysisRequest": { "description": "Request for change analysis computation", "properties": { "analyzedPeriod": { "description": "The analyzed time period (e.g., '2025-02')", "type": "string" }, "attributes": { "description": "Attributes to analyze for significant changes. If empty, valid attributes will be automatically discovered.", "items": { "$ref": "#/components/schemas/AttributeItem" }, "type": "array" }, "auxMeasures": { "description": "Auxiliary measures", "items": { "$ref": "#/components/schemas/MeasureItem" }, "type": "array" }, "dateAttribute": { "$ref": "#/components/schemas/AttributeItem" }, "excludeTags": { "description": "Exclude attributes with any of these tags. This filter applies to both auto-discovered and explicitly provided attributes.", "items": { "description": "Exclude attributes with any of these tags. This filter applies to both auto-discovered and explicitly provided attributes.", "type": "string" }, "type": "array" }, "filters": { "description": "Optional filters to apply.", "items": { "oneOf": [ { "$ref": "#/components/schemas/AbstractMeasureValueFilter" }, { "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" }, { "$ref": "#/components/schemas/InlineFilterDefinition" } ] }, "type": "array" }, "includeTags": { "description": "Only include attributes with at least one of these tags. If empty, no inclusion filter is applied. This filter applies to both auto-discovered and explicitly provided attributes.", "items": { "description": "Only include attributes with at least one of these tags. If empty, no inclusion filter is applied. This filter applies to both auto-discovered and explicitly provided attributes.", "type": "string" }, "type": "array" }, "measure": { "$ref": "#/components/schemas/MeasureItem" }, "referencePeriod": { "description": "The reference time period (e.g., '2025-01')", "type": "string" }, "useSmartAttributeSelection": { "default": false, "description": "Whether to use smart attribute selection (LLM-based) instead of discovering all valid attributes. If true, GenAI will intelligently select the most relevant attributes for change analysis. If false or not set, all valid attributes will be discovered using Calcique. Smart attribute selection applies only when no attributes are provided.", "type": "boolean" } }, "required": [ "analyzedPeriod", "dateAttribute", "measure", "referencePeriod" ], "type": "object" }, "ChangeAnalysisResponse": { "description": "Response for change analysis computation", "properties": { "links": { "$ref": "#/components/schemas/ExecutionLinks" } }, "required": [ "links" ], "type": "object" }, "ChangeAnalysisResult": { "description": "Result of a change analysis execution.", "properties": { "data": { "description": "The change analysis result data containing significant changes.", "items": { "$ref": "#/components/schemas/MetricValueChange" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "ChatHistoryInteraction": { "description": "List of chat history interactions.", "properties": { "changeAnalysisParams": { "$ref": "#/components/schemas/ChangeAnalysisParams" }, "chatHistoryInteractionId": { "description": "Chat History interaction ID. Unique ID for each interaction.", "type": "string" }, "createdVisualizations": { "$ref": "#/components/schemas/CreatedVisualizations" }, "errorResponse": { "description": "Error response in anything fails.", "type": "string" }, "foundObjects": { "$ref": "#/components/schemas/FoundObjects" }, "interactionFinished": { "description": "Has the interaction already finished? Can be used for polling when interaction is in progress.", "type": "boolean" }, "question": { "description": "User question", "maxLength": 2000, "type": "string" }, "reasoning": { "$ref": "#/components/schemas/Reasoning" }, "routing": { "$ref": "#/components/schemas/RouteResult" }, "semanticSearch": { "$ref": "#/components/schemas/SearchResult" }, "textResponse": { "description": "Text response for general questions.", "type": "string" }, "threadIdSuffix": { "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", "type": "string" }, "userFeedback": { "description": "User feedback.", "enum": [ "POSITIVE", "NEGATIVE", "NONE" ], "type": "string" } }, "required": [ "chatHistoryInteractionId", "interactionFinished", "question", "routing" ], "type": "object" }, "ChatHistoryRequest": { "properties": { "chatHistoryInteractionId": { "description": "Return chat history records only after this interaction ID. If empty, complete chat history is returned.", "type": "string" }, "reset": { "description": "User feedback.", "type": "boolean" }, "responseState": { "description": "Response state indicating the outcome of the AI interaction.", "enum": [ "SUCCESSFUL", "UNEXPECTED_ERROR", "NOT_FOUND_ATTRIBUTES", "TOO_MANY_DATA_POINTS", "NO_DATA", "NO_RESULTS", "OUT_OF_TOPIC" ], "type": "string" }, "savedVisualization": { "$ref": "#/components/schemas/SavedVisualization" }, "threadIdSuffix": { "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", "type": "string" }, "userFeedback": { "description": "User feedback.", "enum": [ "POSITIVE", "NEGATIVE", "NONE" ], "type": "string" }, "userTextFeedback": { "description": "User text feedback for the interaction.", "type": "string" } }, "type": "object" }, "ChatHistoryResult": { "properties": { "interactions": { "description": "List of chat history interactions.", "items": { "$ref": "#/components/schemas/ChatHistoryInteraction" }, "type": "array" }, "threadId": { "description": "The conversation thread ID.", "type": "string" } }, "required": [ "interactions", "threadId" ], "type": "object" }, "ChatRequest": { "properties": { "allowedRelationshipTypes": { "description": "Filter relationships and search results based on allowed relationship type combinations. When specified, only relationships matching the allowed types are returned (e.g. for view-only users).", "items": { "$ref": "#/components/schemas/AllowedRelationshipType" }, "type": "array" }, "includeHidden": { "default": false, "description": "If true, includes hidden objects in search and visualization building. If false (default), excludes objects where isHidden=true.", "type": "boolean" }, "limitCreate": { "default": 3, "description": "Maximum number of created results.", "format": "int32", "type": "integer" }, "limitCreateContext": { "default": 10, "description": "Maximum number of relevant objects included into context for LLM (for each object type).", "format": "int32", "type": "integer" }, "limitSearch": { "default": 5, "description": "Maximum number of search results.", "format": "int32", "type": "integer" }, "objectTypes": { "description": "List of object types to filter the search and visualization building. If empty or null, all object types are considered.", "items": { "description": "Object type to filter.", "enum": [ "attribute", "metric", "fact", "label", "date", "dataset", "visualization", "dashboard" ], "type": "string" }, "type": "array" }, "question": { "description": "User question", "maxLength": 2000, "type": "string" }, "relevantScoreThreshold": { "default": 0.45, "description": "Score, above which we return found objects. Below this score objects are not relevant.", "format": "double", "type": "number" }, "searchScoreThreshold": { "default": 0.9, "description": "Score, above which we return found object(s) and don't call LLM to create new objects.", "format": "double", "type": "number" }, "threadIdSuffix": { "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", "type": "string" }, "titleToDescriptorRatio": { "default": 0.7, "description": "Temporary for experiments. Ratio of title score to descriptor score.", "format": "double", "type": "number" }, "userContext": { "$ref": "#/components/schemas/UserContext" } }, "required": [ "question" ], "type": "object" }, "ChatResult": { "properties": { "changeAnalysisParams": { "$ref": "#/components/schemas/ChangeAnalysisParams" }, "chatHistoryInteractionId": { "description": "Chat History interaction ID. Unique ID for each interaction.", "type": "string" }, "createdVisualizations": { "$ref": "#/components/schemas/CreatedVisualizations" }, "errorResponse": { "description": "Error response in anything fails.", "type": "string" }, "foundObjects": { "$ref": "#/components/schemas/FoundObjects" }, "reasoning": { "$ref": "#/components/schemas/Reasoning" }, "routing": { "$ref": "#/components/schemas/RouteResult" }, "semanticSearch": { "$ref": "#/components/schemas/SearchResult" }, "textResponse": { "description": "Text response for general questions.", "type": "string" }, "threadIdSuffix": { "description": "Chat History thread suffix appended to ID generated by backend. Enables more chat windows.", "type": "string" }, "usage": { "description": "AI usage metadata returned after the interaction (e.g. current query count vs. entitlement limit).", "items": { "$ref": "#/components/schemas/AiUsageMetadataItem" }, "type": "array" } }, "type": "object" }, "ChatUsageResponse": { "properties": { "interactionCount": { "description": "Number of interactions in the time window", "format": "int32", "type": "integer" }, "interactionLimit": { "description": "Maximum number of interactions in the time window any user can do in the workspace", "format": "int32", "type": "integer" }, "timeWindowHours": { "description": "Time window in hours", "format": "int32", "type": "integer" } }, "required": [ "interactionCount", "interactionLimit", "timeWindowHours" ], "type": "object" }, "ClusteringConfig": { "description": "Clustering configuration.", "properties": { "numberOfClusters": { "description": "Number of clusters to create", "format": "int32", "type": "integer" }, "threshold": { "description": "Clustering algorithm threshold", "format": "float", "type": "number" } }, "required": [ "numberOfClusters", "threshold" ], "type": "object" }, "ClusteringRequest": { "properties": { "numberOfClusters": { "description": "Number of clusters to create", "format": "int32", "minimum": 1, "type": "integer" }, "threshold": { "default": 0.03, "description": "Threshold used for algorithm", "exclusiveMinimum": true, "format": "double", "minimum": 0, "type": "number" } }, "required": [ "numberOfClusters" ], "type": "object" }, "ClusteringResult": { "properties": { "attribute": { "items": { "type": "object" }, "type": "array" }, "clusters": { "items": { "format": "int32", "nullable": true, "type": "integer" }, "type": "array" }, "xCoord": { "items": { "nullable": true, "type": "number" }, "type": "array", "writeOnly": true }, "xcoord": { "items": { "type": "number" }, "type": "array" }, "yCoord": { "items": { "nullable": true, "type": "number" }, "type": "array", "writeOnly": true }, "ycoord": { "items": { "type": "number" }, "type": "array" } }, "required": [ "attribute", "clusters", "xcoord", "ycoord" ], "type": "object" }, "ColumnExpression": { "description": "Single column projection override: applies `function(column)` to a source column.", "properties": { "column": { "description": "Source column produced by parquet schema inference (after columnOverrides).", "type": "string" }, "function": { "description": "StarRocks transform applied to a source column when projecting it through the generated CREATE PIPE ... AS INSERT statement.", "enum": [ "HLL_HASH", "BITMAP_HASH", "BITMAP_HASH64", "TO_BITMAP" ], "type": "string" } }, "required": [ "column", "function" ], "type": "object" }, "ColumnInfo": { "description": "A single column definition inferred from the parquet schema", "properties": { "name": { "description": "Column name", "type": "string" }, "type": { "description": "SQL column type (e.g. VARCHAR(200), BIGINT, DOUBLE)", "type": "string" } }, "required": [ "name", "type" ], "type": "object" }, "ColumnLocation": { "type": "object" }, "ColumnOverride": { "description": "Table column override.", "properties": { "labelTargetColumn": { "description": "Specifies the attribute's column to which this label is associated.", "example": "users", "type": "string" }, "labelType": { "description": "Label type for the target attribute.", "enum": [ "TEXT", "HYPERLINK", "GEO", "GEO_LONGITUDE", "GEO_LATITUDE", "GEO_AREA", "GEO_ICON", "IMAGE", "HYPERLOGLOG" ], "example": "HYPERLINK", "type": "string" }, "ldmTypeOverride": { "description": "Logical Data Model type for the column.", "enum": [ "FACT", "LABEL" ], "example": "FACT", "type": "string" }, "name": { "description": "Column name.", "example": "column_name", "type": "string" } }, "required": [ "name" ], "type": "object" }, "ColumnPartitionConfig": { "description": "Partition by column expression.", "properties": { "columns": { "description": "Columns to partition by.", "items": { "description": "Columns to partition by.", "type": "string" }, "type": "array" } }, "required": [ "columns" ], "type": "object" }, "ColumnStatistic": { "properties": { "type": { "enum": [ "COUNT", "COUNT_NULL", "COUNT_UNIQUE", "AVG", "STDDEV", "MIN", "MAX", "PERCENTILE_25", "PERCENTILE_50", "PERCENTILE_75" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "ColumnStatisticWarning": { "properties": { "action": { "type": "string" }, "message": { "type": "string" } }, "required": [ "action", "message" ], "type": "object" }, "ColumnStatisticsEntry": { "properties": { "columnName": { "type": "string" }, "dataSize": { "description": "Total data size of the column in bytes.", "format": "int64", "type": "integer" }, "max": { "description": "Maximum value in the column (string-encoded).", "type": "string" }, "min": { "description": "Minimum value in the column (string-encoded).", "type": "string" }, "ndv": { "description": "NDV (Number of Distinct Values) \u2014 approximate cardinality of the column.", "format": "int64", "type": "integer" }, "nullCount": { "description": "Number of NULL values in the column.", "format": "int64", "type": "integer" } }, "required": [ "columnName" ], "type": "object" }, "ColumnStatisticsRequest": { "description": "A request to retrieve statistics for a column.", "properties": { "columnName": { "type": "string" }, "frequency": { "$ref": "#/components/schemas/FrequencyProperties" }, "from": { "oneOf": [ { "$ref": "#/components/schemas/SqlQuery" }, { "$ref": "#/components/schemas/Table" } ] }, "histogram": { "$ref": "#/components/schemas/HistogramProperties" }, "statistics": { "items": { "enum": [ "COUNT", "COUNT_NULL", "COUNT_UNIQUE", "AVG", "STDDEV", "MIN", "MAX", "PERCENTILE_25", "PERCENTILE_50", "PERCENTILE_75" ], "type": "string" }, "type": "array", "uniqueItems": true } }, "required": [ "columnName", "from" ], "type": "object" }, "ColumnStatisticsResponse": { "properties": { "frequency": { "$ref": "#/components/schemas/Frequency" }, "histogram": { "$ref": "#/components/schemas/Histogram" }, "statistics": { "items": { "$ref": "#/components/schemas/ColumnStatistic" }, "type": "array" }, "warnings": { "items": { "$ref": "#/components/schemas/ColumnStatisticWarning" }, "type": "array" } }, "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" }, "Comparison": { "additionalProperties": false, "properties": { "left": { "$ref": "#/components/schemas/LocalIdentifier", "description": "Metric being compared." }, "operator": { "$ref": "#/components/schemas/ComparisonConditionOperator", "description": "Comparison operator.", "enum": [ "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO" ], "type": "string" }, "right": { "$ref": "#/components/schemas/AlertConditionOperand", "description": "Value or metric the left side is compared to.", "oneOf": [ { "$ref": "#/components/schemas/MetricOperand" }, { "$ref": "#/components/schemas/ValueOperand" } ], "title": "Right" } }, "required": [ "left", "operator", "right" ], "title": "Comparison", "type": "object" }, "ComparisonCondition": { "additionalProperties": false, "description": "Condition that compares the metric value to a given constant value using a comparison operator.", "properties": { "comparison": { "$ref": "#/components/schemas/Comparison", "description": "Scalar comparison condition.", "properties": { "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" }, "value": { "example": 100, "type": "number" } }, "required": [ "operator", "value" ], "type": "object" } }, "required": [ "comparison" ], "title": "ComparisonCondition", "type": "object" }, "ComparisonConditionOperator": { "description": "Operator of a scalar comparison condition.", "enum": [ "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO" ], "title": "ComparisonConditionOperator", "type": "string" }, "ComparisonMeasureValueFilter": { "additionalProperties": false, "description": "Filter the result by comparing specified metric to given constant value, using given comparison operator.", "properties": { "comparisonMeasureValueFilter": { "$ref": "#/components/schemas/ComparisonMeasureValueFilterBody", "properties": { "applyOnResult": { "type": "boolean" }, "dimensionality": { "description": "References to the attributes to be used when filtering.", "items": { "$ref": "#/components/schemas/AfmIdentifier" }, "type": "array" }, "localIdentifier": { "type": "string" }, "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": { "description": "A value that will be substituted for null values in the metric for the comparisons.", "example": 0, "type": "number" }, "value": { "example": 1327, "type": "number" } }, "required": [ "measure", "operator", "value" ], "type": "object" } }, "required": [ "comparisonMeasureValueFilter" ], "title": "ComparisonMeasureValueFilter", "type": "object" }, "ComparisonMeasureValueFilterBody": { "additionalProperties": false, "properties": { "applyOnResult": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Applyonresult" }, "dimensionality": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/components/schemas/AfmObjectIdentifier" }, { "$ref": "#/components/schemas/AfmLocalIdentifier" } ] }, "type": "array" }, { "type": "null" } ], "title": "Dimensionality" }, "localIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Localidentifier" }, "measure": { "anyOf": [ { "$ref": "#/components/schemas/AfmObjectIdentifier" }, { "$ref": "#/components/schemas/AfmLocalIdentifier" } ], "title": "Measure" }, "operator": { "$ref": "#/components/schemas/ComparisonMeasureValueOperator" }, "treatNullValuesAs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Treatnullvaluesas" }, "value": { "title": "Value", "type": "number" } }, "required": [ "measure", "operator", "value" ], "title": "ComparisonMeasureValueFilterBody", "type": "object" }, "ComparisonMeasureValueOperator": { "enum": [ "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO" ], "title": "ComparisonMeasureValueOperator", "type": "string" }, "ComparisonWrapper": { "properties": { "comparison": { "$ref": "#/components/schemas/Comparison" } }, "required": [ "comparison" ], "type": "object" }, "CompoundMeasureValueFilter": { "additionalProperties": false, "description": "Filter the result by applying multiple comparison and/or range conditions combined with OR logic. If conditions list is empty, no filtering is applied (all rows are returned).", "properties": { "compoundMeasureValueFilter": { "$ref": "#/components/schemas/CompoundMeasureValueFilterBody", "properties": { "applyOnResult": { "type": "boolean" }, "conditions": { "description": "List of conditions to apply. Conditions are combined with OR logic. Each condition can be either a comparison (e.g., > 100) or a range (e.g., BETWEEN 10 AND 50). If empty, no filtering is applied and all rows are returned.", "items": { "$ref": "#/components/schemas/MeasureValueCondition" }, "type": "array" }, "dimensionality": { "description": "References to the attributes to be used when filtering.", "items": { "$ref": "#/components/schemas/AfmIdentifier" }, "type": "array" }, "localIdentifier": { "type": "string" }, "measure": { "$ref": "#/components/schemas/AfmIdentifier" }, "treatNullValuesAs": { "description": "A value that will be substituted for null values in the metric for the comparisons.", "example": 0, "type": "number" } }, "required": [ "conditions", "measure" ], "type": "object" } }, "required": [ "compoundMeasureValueFilter" ], "title": "CompoundMeasureValueFilter", "type": "object" }, "CompoundMeasureValueFilterBody": { "additionalProperties": false, "properties": { "applyOnResult": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Applyonresult" }, "conditions": { "items": { "anyOf": [ { "$ref": "#/components/schemas/MeasureValueComparisonCondition" }, { "$ref": "#/components/schemas/MeasureValueRangeCondition" } ] }, "title": "Conditions", "type": "array" }, "dimensionality": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/components/schemas/AfmObjectIdentifier" }, { "$ref": "#/components/schemas/AfmLocalIdentifier" } ] }, "type": "array" }, { "type": "null" } ], "title": "Dimensionality" }, "localIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Localidentifier" }, "measure": { "anyOf": [ { "$ref": "#/components/schemas/AfmObjectIdentifier" }, { "$ref": "#/components/schemas/AfmLocalIdentifier" } ], "title": "Measure" }, "treatNullValuesAs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Treatnullvaluesas" } }, "required": [ "measure", "conditions" ], "title": "CompoundMeasureValueFilterBody", "type": "object" }, "ContentSlideTemplate": { "description": "Settings for content slide.", "nullable": true, "properties": { "descriptionField": { "example": "{{dashboardFilters}}", "nullable": true, "type": "string" }, "footer": { "$ref": "#/components/schemas/RunningSection" }, "header": { "$ref": "#/components/schemas/RunningSection" } }, "type": "object" }, "ConversationFeedbackRequest": { "properties": { "feedback": { "anyOf": [ { "$ref": "#/components/schemas/ResponseFeedback" }, { "type": "null" } ] }, "responseId": { "minLength": 1, "title": "Responseid", "type": "string" } }, "required": [ "responseId", "feedback" ], "title": "ConversationFeedbackRequest", "type": "object" }, "ConversationItemListResponse": { "additionalProperties": false, "description": "Conversation item list response.", "properties": { "items": { "description": "Ordered list of conversation items.", "items": { "$ref": "#/components/schemas/ConversationItemResponse" }, "title": "Items", "type": "array" } }, "required": [ "items" ], "title": "ConversationItemListResponse", "type": "object" }, "ConversationItemResponse": { "additionalProperties": false, "description": "Conversation item returned by the agentic HTTP API.", "properties": { "actorUserId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "User who initiated the switch (marker rows only). NULL for drift-driven markers.", "title": "Actoruserid" }, "agentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Agent that processed this item. Populated on every persisted item once LX-2483 ships.", "title": "Agentid" }, "content": { "description": "Conversation item content payload.", "discriminator": { "mapping": { "multipart": "#/components/schemas/MultipartContent", "reasoning": "#/components/schemas/ReasoningContent", "text": "#/components/schemas/TextMessageContent", "toolCall": "#/components/schemas/FunctionCallContent", "toolResult": "#/components/schemas/FunctionResultContent" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/TextMessageContent" }, { "$ref": "#/components/schemas/ReasoningContent" }, { "$ref": "#/components/schemas/MultipartContent" }, { "$ref": "#/components/schemas/FunctionCallContent" }, { "$ref": "#/components/schemas/FunctionResultContent" } ], "title": "Content" }, "conversationId": { "description": "Parent conversation identifier.", "title": "Conversationid", "type": "string" }, "createdAt": { "description": "Item creation timestamp (ISO-8601 UTC).", "title": "Createdat", "type": "string" }, "itemId": { "description": "Conversation item identifier.", "title": "Itemid", "type": "string" }, "itemIndex": { "description": "Zero-based item order within the response turn.", "title": "Itemindex", "type": "integer" }, "newAgentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Agent ID after the switch (marker rows only).", "title": "Newagentid" }, "oldAgentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Agent ID before the switch (marker rows only).", "title": "Oldagentid" }, "replyTo": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional parent item identifier.", "title": "Replyto" }, "responseId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Response/turn identifier grouping related items.", "title": "Responseid" }, "role": { "description": "Author role of the item.", "enum": [ "user", "assistant", "tool", "system" ], "title": "Role", "type": "string" }, "taskId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Task identifier grouping related work items.", "title": "Taskid" }, "trigger": { "anyOf": [ { "enum": [ "agent_switched", "agent_updated" ], "type": "string" }, { "type": "null" } ], "description": "Why the marker was written (marker rows only).", "title": "Trigger" } }, "required": [ "itemId", "conversationId", "itemIndex", "createdAt", "role", "content" ], "title": "ConversationItemResponse", "type": "object" }, "ConversationListMeta": { "additionalProperties": false, "properties": { "page": { "$ref": "#/components/schemas/ConversationListPageMeta" } }, "required": [ "page" ], "title": "ConversationListMeta", "type": "object" }, "ConversationListPageMeta": { "additionalProperties": false, "properties": { "page": { "description": "Zero-based page index.", "title": "Page", "type": "integer" }, "size": { "description": "Requested page size.", "title": "Size", "type": "integer" }, "total": { "description": "Total count of available conversations.", "title": "Total", "type": "integer" } }, "required": [ "page", "size", "total" ], "title": "ConversationListPageMeta", "type": "object" }, "ConversationListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "$ref": "#/components/schemas/ConversationResponse" }, "title": "Data", "type": "array" }, "meta": { "$ref": "#/components/schemas/ConversationListMeta" } }, "required": [ "data", "meta" ], "title": "ConversationListResponse", "type": "object" }, "ConversationResponse": { "additionalProperties": false, "description": "Conversation returned by the agentic HTTP API.", "properties": { "agentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Identifier of the agent bound to this conversation (if any).", "title": "Agentid" }, "conversationId": { "description": "Conversation identifier.", "title": "Conversationid", "type": "string" }, "createdAt": { "description": "Conversation creation timestamp (ISO-8601 UTC).", "title": "Createdat", "type": "string" }, "isPreview": { "default": false, "description": "Whether this is a preview conversation.", "title": "Ispreview", "type": "boolean" }, "lastActivityAt": { "description": "Last activity timestamp (ISO-8601 UTC).", "title": "Lastactivityat", "type": "string" }, "organizationId": { "description": "Organization identifier.", "title": "Organizationid", "type": "string" }, "pinned": { "default": false, "description": "Whether this conversation is pinned by the user.", "title": "Pinned", "type": "boolean" }, "title": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "description": "Conversation title.", "title": "Title" }, "userId": { "description": "Owner user identifier.", "title": "Userid", "type": "string" }, "workspaceId": { "description": "Workspace identifier.", "title": "Workspaceid", "type": "string" } }, "required": [ "conversationId", "workspaceId", "organizationId", "userId", "createdAt", "lastActivityAt" ], "title": "ConversationResponse", "type": "object" }, "ConversationResponseList": { "additionalProperties": false, "properties": { "responses": { "description": "Conversation responses.", "items": { "$ref": "#/components/schemas/ConversationTurnResponse" }, "title": "Responses", "type": "array" } }, "required": [ "responses" ], "title": "ConversationResponseList", "type": "object" }, "ConversationTurnResponse": { "additionalProperties": false, "properties": { "createdAt": { "description": "Response creation timestamp (ISO-8601 UTC).", "title": "Createdat", "type": "string" }, "feedback": { "anyOf": [ { "$ref": "#/components/schemas/Feedback" }, { "type": "null" } ], "description": "Optional user feedback." }, "responseId": { "description": "Response identifier.", "title": "Responseid", "type": "string" }, "updatedAt": { "description": "Response update timestamp (ISO-8601 UTC).", "title": "Updatedat", "type": "string" } }, "required": [ "responseId", "createdAt", "updatedAt" ], "title": "ConversationTurnResponse", "type": "object" }, "ConversationUpdateRequest": { "description": "PATCH /conversations/{conversationId} body.", "properties": { "pinned": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Pinned" }, "title": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Title" } }, "title": "ConversationUpdateRequest", "type": "object" }, "ConvertGeoFileRequest": { "description": "Request to convert a geo file to GeoParquet format.", "properties": { "location": { "description": "Location of the file in the staging area to convert.", "type": "string" } }, "required": [ "location" ], "type": "object" }, "ConvertGeoFileResponse": { "description": "Response after successfully converting a geo file.", "properties": { "location": { "description": "Location of the converted GeoParquet file in the staging area.", "type": "string" } }, "required": [ "location" ], "type": "object" }, "CoverSlideTemplate": { "description": "Settings for cover slide.", "nullable": true, "properties": { "backgroundImage": { "default": true, "description": "Show background image on the slide.", "type": "boolean" }, "descriptionField": { "example": "Exported at: {{exportedAt}}", "nullable": true, "type": "string" }, "footer": { "$ref": "#/components/schemas/RunningSection" }, "header": { "$ref": "#/components/schemas/RunningSection" } }, "type": "object" }, "CreateConversationRequest": { "description": "POST /conversations body.", "properties": { "agentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Agentid" } }, "title": "CreateConversationRequest", "type": "object" }, "CreatePipeTableRequest": { "description": "Request to create a new pipe-backed OLAP table in the AI Lake", "properties": { "aggregationOverrides": { "additionalProperties": { "description": "Maps non-key column names to their StarRocks aggregation function (SUM, MIN, MAX, REPLACE, REPLACE_IF_NOT_NULL, HLL_UNION, BITMAP_UNION, PERCENTILE_UNION). Required for every non-key column when keyConfig type is 'aggregate'. Ignored for other key types.", "type": "string" }, "description": "Maps non-key column names to their StarRocks aggregation function (SUM, MIN, MAX, REPLACE, REPLACE_IF_NOT_NULL, HLL_UNION, BITMAP_UNION, PERCENTILE_UNION). Required for every non-key column when keyConfig type is 'aggregate'. Ignored for other key types.", "type": "object" }, "columnExpressions": { "additionalProperties": { "$ref": "#/components/schemas/ColumnExpression" }, "description": "Per-target-column projection overrides. Each entry emits `() AS ` in the SELECT list of the generated CREATE PIPE ... AS INSERT; keys absent from the map are projected as-is. Required for AGGREGATE-KEY tables that include native HLL columns (StarRocks rejects raw VARBINARY into HLL columns).", "type": "object" }, "columnOverrides": { "additionalProperties": { "description": "Override inferred column types. Maps column names to SQL type strings (e.g. {\"year\": \"INT\", \"event_date\": \"DATE\"}). Applied after parquet schema inference.", "type": "string" }, "description": "Override inferred column types. Maps column names to SQL type strings (e.g. {\"year\": \"INT\", \"event_date\": \"DATE\"}). Applied after parquet schema inference.", "type": "object" }, "distributionConfig": { "$ref": "#/components/schemas/DistributionConfig" }, "keyConfig": { "$ref": "#/components/schemas/KeyConfig" }, "maxVarcharLength": { "description": "Cap VARCHAR(N) to this length when N exceeds it. 0 = no cap.", "format": "int32", "type": "integer" }, "partitionConfig": { "$ref": "#/components/schemas/PartitionConfig" }, "pathPrefix": { "description": "Path prefix to the parquet files (e.g. 'my-dataset/year=2024/'). All parquet files must be at a uniform depth under the prefix \u2014 either all directly under the prefix, or all under a consistent Hive partition hierarchy (e.g. year=2024/month=01/). Mixed layouts (files at multiple depths) are not supported.", "type": "string" }, "pollingIntervalSeconds": { "description": "How often (in seconds) the pipe polls for new files. 0 or null = use server default.", "format": "int32", "type": "integer" }, "sourceStorageName": { "description": "Name of the pre-configured S3/MinIO ObjectStorage source", "type": "string" }, "tableName": { "description": "Name of the OLAP table to create. Must match ^[a-z][a-z0-9_-]{0,62}$", "type": "string" }, "tableProperties": { "additionalProperties": { "description": "CREATE TABLE PROPERTIES key-value pairs. Defaults to {\"replication_num\": \"1\"}.", "type": "string" }, "description": "CREATE TABLE PROPERTIES key-value pairs. Defaults to {\"replication_num\": \"1\"}.", "type": "object" } }, "required": [ "pathPrefix", "sourceStorageName", "tableName" ], "type": "object" }, "CreatedVisualization": { "description": "List of created visualization objects", "properties": { "config": { "$ref": "#/components/schemas/VisualizationConfig" }, "dimensionality": { "description": "List of attributes representing the dimensionality of the new visualization", "items": { "$ref": "#/components/schemas/DimAttribute" }, "type": "array" }, "filters": { "description": "List of filters to be applied to the new visualization", "items": { "oneOf": [ { "$ref": "#/components/schemas/AttributeNegativeFilter" }, { "$ref": "#/components/schemas/AttributePositiveFilter" }, { "$ref": "#/components/schemas/DateAbsoluteFilter" }, { "$ref": "#/components/schemas/DateRelativeFilter" }, { "$ref": "#/components/schemas/RankingFilter" } ] }, "type": "array" }, "id": { "description": "Proposed ID of the new visualization", "example": "revenue_by_country", "type": "string" }, "metrics": { "description": "List of metrics to be used in the new visualization", "items": { "$ref": "#/components/schemas/Metric" }, "type": "array" }, "savedVisualizationId": { "description": "Saved visualization ID.", "type": "string" }, "suggestions": { "description": "Suggestions for next steps", "items": { "$ref": "#/components/schemas/Suggestion" }, "type": "array" }, "title": { "description": "Proposed title of the new visualization", "example": "Revenue by Country", "type": "string" }, "visualizationType": { "description": "Visualization type requested in question", "enum": [ "TABLE", "HEADLINE", "BAR", "LINE", "PIE", "COLUMN", "SCATTER" ], "example": "TABLE", "type": "string" } }, "required": [ "dimensionality", "filters", "id", "metrics", "suggestions", "title", "visualizationType" ], "type": "object" }, "CreatedVisualizations": { "description": "Visualization definitions created by AI.", "properties": { "objects": { "description": "List of created visualization objects", "items": { "$ref": "#/components/schemas/CreatedVisualization" }, "type": "array" }, "reasoning": { "description": "DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated.", "type": "string" }, "suggestions": { "description": "List of suggestions for next steps. Filled when no visualization was created, suggests alternatives.", "items": { "$ref": "#/components/schemas/Suggestion" }, "type": "array" } }, "required": [ "objects", "reasoning", "suggestions" ], "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" }, "CsvManifestBody": { "description": "Body of the CSV manifest.", "properties": { "column_date_formats": { "additionalProperties": { "description": "Map of column names to date formats to use when parsing them as dates.", "type": "string" }, "description": "Map of column names to date formats to use when parsing them as dates.", "type": "object" }, "convert": { "$ref": "#/components/schemas/CsvConvertOptions" }, "parse": { "$ref": "#/components/schemas/CsvParseOptions" }, "read": { "$ref": "#/components/schemas/CsvReadOptions" }, "read_method": { "description": "Method used to read the CSV file.", "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" }, "DashboardArbitraryAttributeFilter": { "properties": { "arbitraryAttributeFilter": { "properties": { "displayForm": { "$ref": "#/components/schemas/IdentifierRef" }, "filterElementsBy": { "items": { "$ref": "#/components/schemas/AttributeFilterParent" }, "type": "array" }, "filterElementsByDate": { "items": { "$ref": "#/components/schemas/AttributeFilterByDate" }, "type": "array" }, "localIdentifier": { "type": "string" }, "negativeSelection": { "type": "boolean" }, "title": { "type": "string" }, "validateElementsBy": { "items": { "$ref": "#/components/schemas/IdentifierRef" }, "type": "array" }, "values": { "items": { "type": "string" }, "type": "array" } }, "required": [ "displayForm", "negativeSelection", "values" ], "type": "object" } }, "required": [ "arbitraryAttributeFilter" ], "type": "object" }, "DashboardAttributeFilter": { "properties": { "attributeFilter": { "properties": { "attributeElements": { "$ref": "#/components/schemas/AttributeElements" }, "displayForm": { "$ref": "#/components/schemas/IdentifierRef" }, "filterElementsBy": { "items": { "$ref": "#/components/schemas/AttributeFilterParent" }, "type": "array" }, "filterElementsByDate": { "items": { "$ref": "#/components/schemas/AttributeFilterByDate" }, "type": "array" }, "localIdentifier": { "type": "string" }, "negativeSelection": { "type": "boolean" }, "selectionMode": { "enum": [ "single", "multi" ], "type": "string" }, "title": { "type": "string" }, "validateElementsBy": { "items": { "$ref": "#/components/schemas/IdentifierRef" }, "type": "array" } }, "required": [ "attributeElements", "displayForm", "negativeSelection" ], "type": "object" } }, "required": [ "attributeFilter" ], "type": "object" }, "DashboardCompoundComparisonCondition": { "properties": { "comparison": { "properties": { "operator": { "enum": [ "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO" ], "type": "string" }, "treatNullValuesAs": { "format": "double", "type": "number" }, "value": { "format": "double", "type": "number" } }, "required": [ "operator", "value" ], "type": "object" } }, "required": [ "comparison" ], "type": "object" }, "DashboardCompoundConditionItem": { "oneOf": [ { "$ref": "#/components/schemas/DashboardCompoundComparisonCondition" }, { "$ref": "#/components/schemas/DashboardCompoundRangeCondition" } ], "type": "object" }, "DashboardCompoundRangeCondition": { "properties": { "range": { "properties": { "from": { "format": "double", "type": "number" }, "operator": { "enum": [ "BETWEEN", "NOT_BETWEEN" ], "type": "string" }, "to": { "format": "double", "type": "number" }, "treatNullValuesAs": { "format": "double", "type": "number" } }, "required": [ "from", "operator", "to" ], "type": "object" } }, "required": [ "range" ], "type": "object" }, "DashboardContext": { "description": "Dashboard the user is currently viewing.", "properties": { "id": { "description": "Dashboard object ID.", "type": "string" }, "widgets": { "description": "Widgets currently visible on the dashboard.", "items": { "$ref": "#/components/schemas/WidgetDescriptor" }, "type": "array" } }, "required": [ "id", "widgets" ], "type": "object" }, "DashboardDateFilter": { "properties": { "dateFilter": { "properties": { "attribute": { "$ref": "#/components/schemas/IdentifierRef" }, "boundedFilter": { "$ref": "#/components/schemas/RelativeBoundedDateFilter" }, "dataSet": { "$ref": "#/components/schemas/IdentifierRef" }, "emptyValueHandling": { "enum": [ "include", "exclude", "only" ], "type": "string" }, "from": { "oneOf": [ { "type": "string" }, { "format": "int32", "type": "integer" } ] }, "granularity": { "enum": [ "ALL_TIME_GRANULARITY", "GDC.time.year", "GDC.time.week_us", "GDC.time.week_in_year", "GDC.time.week_in_quarter", "GDC.time.week", "GDC.time.euweek_in_year", "GDC.time.euweek_in_quarter", "GDC.time.quarter", "GDC.time.quarter_in_year", "GDC.time.month", "GDC.time.month_in_quarter", "GDC.time.month_in_year", "GDC.time.day_in_year", "GDC.time.day_in_quarter", "GDC.time.day_in_month", "GDC.time.day_in_week", "GDC.time.day_in_euweek", "GDC.time.date", "GDC.time.hour", "GDC.time.hour_in_day", "GDC.time.minute", "GDC.time.minute_in_hour", "GDC.time.fiscal_month", "GDC.time.fiscal_quarter", "GDC.time.fiscal_year" ], "type": "string" }, "localIdentifier": { "type": "string" }, "to": { "oneOf": [ { "type": "string" }, { "format": "int32", "type": "integer" } ] }, "type": { "enum": [ "relative", "absolute" ], "type": "string" } }, "required": [ "granularity", "type" ], "type": "object" } }, "required": [ "dateFilter" ], "type": "object" }, "DashboardExportSettings": { "description": "Additional settings.", "properties": { "exportInfo": { "default": false, "description": "If true, the export will contain the information about the export \u2013 exported date, dashboard filters, etc.", "example": true, "type": "boolean" }, "mergeHeaders": { "default": false, "description": "Merge equal headers in neighbouring cells. Used for [XLSX] format only.", "example": true, "type": "boolean" }, "pageOrientation": { "default": "PORTRAIT", "description": "Set page orientation. (PDF)", "enum": [ "PORTRAIT", "LANDSCAPE" ], "type": "string" }, "pageSize": { "default": "A4", "description": "Set page size. (PDF)", "enum": [ "A3", "A4", "LETTER" ], "type": "string" } }, "type": "object" }, "DashboardFilter": { "oneOf": [ { "$ref": "#/components/schemas/DashboardAttributeFilter" }, { "$ref": "#/components/schemas/DashboardDateFilter" }, { "$ref": "#/components/schemas/DashboardArbitraryAttributeFilter" }, { "$ref": "#/components/schemas/DashboardMatchAttributeFilter" }, { "$ref": "#/components/schemas/DashboardMeasureValueFilter" } ], "type": "object" }, "DashboardMatchAttributeFilter": { "properties": { "matchAttributeFilter": { "properties": { "caseSensitive": { "type": "boolean" }, "displayForm": { "$ref": "#/components/schemas/IdentifierRef" }, "literal": { "type": "string" }, "localIdentifier": { "type": "string" }, "negativeSelection": { "type": "boolean" }, "operator": { "enum": [ "contains", "startsWith", "endsWith" ], "type": "string" }, "title": { "type": "string" } }, "required": [ "caseSensitive", "displayForm", "literal", "negativeSelection", "operator" ], "type": "object" } }, "required": [ "matchAttributeFilter" ], "type": "object" }, "DashboardMeasureValueFilter": { "properties": { "dashboardMeasureValueFilter": { "properties": { "conditions": { "items": { "$ref": "#/components/schemas/DashboardCompoundConditionItem" }, "type": "array" }, "dimensionality": { "items": { "$ref": "#/components/schemas/IdentifierRef" }, "type": "array" }, "localIdentifier": { "type": "string" }, "measure": { "$ref": "#/components/schemas/IdentifierRef" }, "title": { "type": "string" } }, "required": [ "conditions", "measure" ], "type": "object" } }, "required": [ "dashboardMeasureValueFilter" ], "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" }, "DashboardRef": { "additionalProperties": false, "properties": { "id": { "description": "Bound dashboard identifier.", "title": "Id", "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Bound dashboard display title.", "title": "Title" } }, "required": [ "id" ], "title": "DashboardRef", "type": "object" }, "DashboardSlidesTemplate": { "description": "Template for dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", "nullable": true, "properties": { "appliedOn": { "description": "Export types this template applies to.", "example": [ "PDF", "PPTX" ], "items": { "enum": [ "PDF", "PPTX" ], "type": "string" }, "minItems": 1, "type": "array" }, "contentSlide": { "$ref": "#/components/schemas/ContentSlideTemplate" }, "coverSlide": { "$ref": "#/components/schemas/CoverSlideTemplate" }, "introSlide": { "$ref": "#/components/schemas/IntroSlideTemplate" }, "sectionSlide": { "$ref": "#/components/schemas/SectionSlideTemplate" } }, "required": [ "appliedOn" ], "type": "object" }, "DashboardTabularExportRequest": { "description": "Export request object describing the export properties for dashboard tabular exports.", "properties": { "dashboardFiltersOverride": { "description": "List of filters that will be used instead of the default dashboard filters.", "items": { "$ref": "#/components/schemas/DashboardFilter" }, "type": "array" }, "dashboardParametersOverride": { "description": "Parameter value overrides applied to the export's executions. Each entry carries the parameter id (used as an AFM execution override) plus the FE-supplied title for the info sheet. Applied uniformly across all tabs; use dashboardTabsParametersOverrides for tab-scoped overrides.", "items": { "$ref": "#/components/schemas/ParameterValue" }, "type": "array" }, "dashboardTabsFiltersOverrides": { "additionalProperties": { "items": { "$ref": "#/components/schemas/DashboardFilter" }, "type": "array" }, "description": "Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab.", "type": "object" }, "dashboardTabsParametersOverrides": { "additionalProperties": { "items": { "$ref": "#/components/schemas/ParameterValue" }, "type": "array" }, "description": "Map of tab-specific parameter overrides. Key is tabId, value is a list of (id, value, title) entries that override the dashboard-level parameters for that tab only. Mirrors dashboardTabsFiltersOverrides. When a tab is present in this map, its entries take precedence over dashboardParametersOverride for that tab's executions and info-sheet display.", "type": "object" }, "fileName": { "description": "Filename of downloaded file without extension.", "example": "result", "type": "string" }, "format": { "description": "Requested tabular export type.", "enum": [ "XLSX", "PDF" ], "example": "XLSX", "type": "string" }, "settings": { "$ref": "#/components/schemas/DashboardExportSettings" }, "widgetIds": { "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.", "items": { "type": "string" }, "maxItems": 1, "type": "array", "uniqueItems": true } }, "required": [ "fileName", "format" ], "type": "object" }, "DashboardTabularExportRequestV2": { "description": "Export request object describing the export properties for dashboard tabular exports (v2 with dashboardId).", "properties": { "dashboardFiltersOverride": { "description": "List of filters that will be used instead of the default dashboard filters.", "items": { "$ref": "#/components/schemas/DashboardFilter" }, "type": "array" }, "dashboardId": { "description": "Dashboard identifier", "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", "type": "string" }, "dashboardParametersOverride": { "description": "Parameter value overrides applied to the export's executions. Each entry carries the parameter id (used as an AFM execution override) plus the FE-supplied title for the info sheet. Applied uniformly across all tabs; use dashboardTabsParametersOverrides for tab-scoped overrides.", "items": { "$ref": "#/components/schemas/ParameterValue" }, "type": "array" }, "dashboardTabsFiltersOverrides": { "additionalProperties": { "items": { "$ref": "#/components/schemas/DashboardFilter" }, "type": "array" }, "description": "Map of tab-specific filter overrides. Key is tabId, value is list of filters for that tab.", "type": "object" }, "dashboardTabsParametersOverrides": { "additionalProperties": { "items": { "$ref": "#/components/schemas/ParameterValue" }, "type": "array" }, "description": "Map of tab-specific parameter overrides. Key is tabId, value is a list of (id, value, title) entries that override the dashboard-level parameters for that tab only. Mirrors dashboardTabsFiltersOverrides. When a tab is present in this map, its entries take precedence over dashboardParametersOverride for that tab's executions and info-sheet display.", "type": "object" }, "fileName": { "description": "Filename of downloaded file without extension.", "example": "result", "type": "string" }, "format": { "description": "Requested tabular export type.", "enum": [ "XLSX", "PDF" ], "example": "XLSX", "type": "string" }, "settings": { "$ref": "#/components/schemas/DashboardExportSettings" }, "widgetIds": { "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.", "items": { "type": "string" }, "maxItems": 1, "type": "array", "uniqueItems": true } }, "required": [ "dashboardId", "fileName", "format" ], "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": { "description": "Data column locators for the values.", "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" }, "DataSourceInfo": { "description": "A single data source association for an AI Lake Database instance", "properties": { "dataSourceId": { "description": "Identifier of the data source in metadata-api.", "type": "string" }, "dataSourceName": { "description": "Display name of the data source in metadata-api.", "type": "string" }, "id": { "description": "Id of the data source association record.", "type": "string" } }, "required": [ "dataSourceId", "dataSourceName", "id" ], "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" }, "DataSourceStatisticsRequest": { "properties": { "tables": { "items": { "$ref": "#/components/schemas/TableStatisticsEntry" }, "type": "array" } }, "required": [ "tables" ], "type": "object" }, "DataSourceStatisticsResponse": { "properties": { "tables": { "items": { "$ref": "#/components/schemas/TableStatisticsEntry" }, "type": "array" } }, "required": [ "tables" ], "type": "object" }, "DataSourceTableIdentifier": { "description": "An id of the table. Including ID of data source. Must NOT be set on AUXILIARY datasets.", "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" }, "DatabaseInstance": { "description": "A single AI Lake Database instance", "properties": { "dataSources": { "description": "All data source associations for this database instance.", "items": { "$ref": "#/components/schemas/DataSourceInfo" }, "type": "array" }, "id": { "description": "Id of the AI Lake Database instance", "type": "string" }, "name": { "description": "Name of the AI Lake Database instance", "type": "string" }, "storageIds": { "description": "Set of ids of the storage instances this database instance should access.", "items": { "description": "Set of ids of the storage instances this database instance should access.", "type": "string" }, "type": "array", "uniqueItems": true } }, "required": [ "dataSources", "id", "name", "storageIds" ], "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" }, "DateAbsoluteFilter": { "allOf": [ { "$ref": "#/components/schemas/Filter" }, { "properties": { "from": { "type": "string" }, "to": { "type": "string" }, "using": { "type": "string" } }, "type": "object" } ], "required": [ "from", "to", "using" ], "type": "object" }, "DateFilter": { "description": "Abstract filter definition type for dates.", "oneOf": [ { "$ref": "#/components/schemas/AbsoluteDateFilter" }, { "$ref": "#/components/schemas/RelativeDateFilter" }, { "$ref": "#/components/schemas/AllTimeDateFilter" } ], "type": "object" }, "DateFilterAbsolute": { "additionalProperties": false, "properties": { "from": { "title": "From", "type": "string" }, "to": { "title": "To", "type": "string" }, "type": { "const": "date_filter", "title": "Type", "type": "string" }, "using": { "title": "Using", "type": "string" } }, "required": [ "type", "using", "from", "to" ], "title": "DateFilterAbsolute", "type": "object" }, "DateFilterGranularity": { "enum": [ "MINUTE", "HOUR", "DAY", "WEEK_US", "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" }, "DateFilterRelative": { "additionalProperties": false, "properties": { "from": { "title": "From", "type": "integer" }, "granularity": { "$ref": "#/components/schemas/app__domain__conversations__visualization__DateGranularity" }, "to": { "title": "To", "type": "integer" }, "type": { "const": "date_filter", "title": "Type", "type": "string" }, "using": { "title": "Using", "type": "string" } }, "required": [ "type", "using", "granularity", "from", "to" ], "title": "DateFilterRelative", "type": "object" }, "DateGranularity-Input": { "enum": [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR" ], "title": "DateGranularity", "type": "string" }, "DateRelativeFilter": { "allOf": [ { "$ref": "#/components/schemas/Filter" }, { "properties": { "from": { "format": "int32", "type": "integer" }, "granularity": { "enum": [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR" ], "type": "string" }, "to": { "format": "int32", "type": "integer" }, "using": { "type": "string" } }, "type": "object" } ], "required": [ "from", "granularity", "to", "using" ], "type": "object" }, "DateTruncPartitionConfig": { "description": "Partition by date_trunc() expression.", "properties": { "column": { "description": "Column to partition on.", "type": "string" }, "unit": { "description": "Date/time unit for partition granularity", "enum": [ "year", "quarter", "month", "week", "day", "hour", "minute", "second", "millisecond", "microsecond" ], "type": "string" } }, "required": [ "column", "unit" ], "type": "object" }, "DateValue": { "properties": { "value": { "type": "string" } }, "required": [ "value" ], "type": "object" }, "DeclarativeAgent": { "description": "A declarative form of an AI agent configuration.", "properties": { "aiKnowledge": { "description": "Whether AI knowledge is enabled.", "type": "boolean" }, "availableToAll": { "description": "Whether the agent is available to all users.", "type": "boolean" }, "createdAt": { "description": "Time of the entity creation.", "example": "2023-07-20 12:30", "nullable": true, "type": "string" }, "createdBy": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, "customSkills": { "description": "List of custom skills when skillsMode is CUSTOM.", "items": { "description": "List of custom skills when skillsMode is CUSTOM.", "enum": [ "alert", "anomaly_detection", "clustering", "forecasting", "key_driver_analysis", "metric", "schedule_export", "visualization", "visualization_summary", "dashboard_summary", "what_if_analysis", "knowledge" ], "type": "string" }, "type": "array" }, "description": { "description": "Description of the agent.", "maxLength": 10000, "type": "string" }, "enabled": { "description": "Whether the agent is enabled.", "example": true, "type": "boolean" }, "id": { "description": "Identifier of an agent.", "example": "default-ai-assistant", "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, "type": "string" }, "modifiedBy": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, "name": { "description": "Name of the agent.", "example": "Default AI Assistant", "maxLength": 255, "type": "string" }, "personality": { "description": "Personality instructions for the agent.", "type": "string" }, "skillsMode": { "description": "Skills mode: ALL or CUSTOM.", "enum": [ "all", "custom" ], "type": "string" }, "userGroups": { "description": "User groups this agent is assigned to.", "items": { "$ref": "#/components/schemas/DeclarativeUserGroupIdentifier" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "DeclarativeAgents": { "description": "AI agent configurations.", "properties": { "agents": { "items": { "$ref": "#/components/schemas/DeclarativeAgent" }, "type": "array" } }, "required": [ "agents" ], "type": "object" }, "DeclarativeAggregatedFact": { "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" }, "isNullable": { "description": "Flag indicating whether the associated source column allows null values.", "example": false, "type": "boolean" }, "nullValue": { "description": "Value used in coalesce during joins instead of null.", "example": "0", "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", "HLL" ], "example": "NUMERIC", "maxLength": 255, "type": "string" }, "sourceFactReference": { "$ref": "#/components/schemas/DeclarativeSourceReference" }, "tags": { "description": "A list of tags.", "example": [ "Customers" ], "items": { "description": "A list of tags.", "example": "[\"Customers\"]", "type": "string" }, "type": "array", "uniqueItems": true } }, "required": [ "id", "sourceFactReference" ], "type": "object" }, "DeclarativeAnalyticalDashboard": { "properties": { "certification": { "description": "Certification status of the entity.", "enum": [ "CERTIFIED" ], "type": "string" }, "certificationMessage": { "description": "Optional message associated with the certification.", "nullable": true, "type": "string" }, "certifiedAt": { "description": "Time when the certification was set.", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "certifiedBy": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, "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" }, "summary": { "description": "AI-generated summary of the dashboard content", "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": "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" }, "DeclarativeAnalyticalDashboardIdentifier": { "description": "An analytical dashboard identifier.", "properties": { "id": { "description": "Identifier of the analytical dashboard.", "example": "dashboard123", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "A type.", "enum": [ "analyticalDashboard" ], "example": "analyticalDashboard", "type": "string" } }, "required": [ "id", "type" ], "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" }, "exportDefinitions": { "description": "A list of export definitions.", "items": { "$ref": "#/components/schemas/DeclarativeExportDefinition" }, "type": "array" }, "filterContexts": { "description": "A list of filter contexts available in the model.", "items": { "$ref": "#/components/schemas/DeclarativeFilterContext" }, "type": "array" }, "memoryItems": { "description": "A list of AI memory items available in the workspace.", "items": { "$ref": "#/components/schemas/DeclarativeMemoryItem" }, "type": "array" }, "metrics": { "description": "A list of metrics available in the model.", "items": { "$ref": "#/components/schemas/DeclarativeMetric" }, "type": "array" }, "parameters": { "description": "A list of parameters available in the model.", "items": { "$ref": "#/components/schemas/DeclarativeParameter" }, "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" }, "isHidden": { "description": "If true, this attribute is hidden from AI search results.", "example": false, "type": "boolean" }, "isNullable": { "description": "Flag indicating whether the associated source column allows null values.", "example": false, "type": "boolean" }, "labels": { "description": "An array of attribute labels.", "items": { "$ref": "#/components/schemas/DeclarativeLabel" }, "type": "array" }, "locale": { "description": "Default locale for primary label.", "example": "en-US", "type": "string" }, "nullValue": { "description": "Value used in coalesce during joins instead of null.", "example": "empty_value", "type": "string" }, "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", "HLL" ], "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", "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" }, "DeclarativeAutomation": { "properties": { "alert": { "$ref": "#/components/schemas/AutomationAlert" }, "analyticalDashboard": { "$ref": "#/components/schemas/DeclarativeAnalyticalDashboardIdentifier" }, "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" }, "dashboardTabularExports": { "items": { "$ref": "#/components/schemas/AutomationDashboardTabularExport" }, "type": "array", "uniqueItems": true }, "description": { "maxLength": 255, "type": "string" }, "details": { "additionalProperties": { "description": "TODO", "maxLength": 10000, "type": "string" }, "description": "TODO", "maxLength": 10000, "type": "object" }, "evaluationMode": { "default": "PER_RECIPIENT", "description": "Specify automation evaluation mode.", "enum": [ "SHARED", "PER_RECIPIENT" ], "type": "string" }, "exportDefinitions": { "items": { "$ref": "#/components/schemas/DeclarativeExportDefinitionIdentifier" }, "type": "array", "uniqueItems": true }, "externalRecipients": { "description": "External recipients of the automation action results.", "items": { "$ref": "#/components/schemas/AutomationExternalRecipient" }, "type": "array", "uniqueItems": true }, "id": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "imageExports": { "items": { "$ref": "#/components/schemas/AutomationImageExport" }, "type": "array", "uniqueItems": true }, "metadata": { "$ref": "#/components/schemas/AutomationMetadata" }, "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" }, "notificationChannel": { "$ref": "#/components/schemas/DeclarativeNotificationChannelIdentifier" }, "rawExports": { "items": { "$ref": "#/components/schemas/AutomationRawExport" }, "type": "array", "uniqueItems": true }, "recipients": { "items": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, "type": "array", "uniqueItems": true }, "schedule": { "$ref": "#/components/schemas/AutomationSchedule" }, "slidesExports": { "items": { "$ref": "#/components/schemas/AutomationSlidesExport" }, "type": "array", "uniqueItems": true }, "state": { "default": "ACTIVE", "description": "Current state of the automation.", "enum": [ "ACTIVE", "PAUSED" ], "type": "string" }, "tabularExports": { "items": { "$ref": "#/components/schemas/AutomationTabularExport" }, "type": "array", "uniqueItems": true }, "tags": { "items": { "description": "A list of tags.", "example": "[\"Revenue\",\"Sales\"]", "type": "string" }, "type": "array", "uniqueItems": true }, "title": { "maxLength": 255, "type": "string" }, "visualExports": { "items": { "$ref": "#/components/schemas/AutomationVisualExport" }, "type": "array", "uniqueItems": true } }, "required": [ "id" ], "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", "HLL" ], "example": "INT", "type": "string" }, "description": { "description": "Column description/comment from database", "example": "Customer unique identifier", "maxLength": 10000, "type": "string" }, "isNullable": { "description": "Column is nullable", "type": "boolean" }, "isPrimaryKey": { "description": "Is column part of primary key?", "type": "boolean" }, "name": { "description": "Column name. Must not contain NUL (0x00) characters.", "example": "customer_id", "maxLength": 255, "type": "string" }, "nullValue": { "description": "Value used as sentinel for nullable columns", "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": { "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": {}, "maxLength": 250000, "nullable": true, "type": "object" }, "id": { "description": "Custom Application Setting ID.", "example": "modeler.demo", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, "required": [ "applicationName", "content", "id" ], "type": "object" }, "DeclarativeCustomGeoCollection": { "description": "A declarative form of custom geo collection.", "properties": { "description": { "description": "Description of the custom geo collection.", "maxLength": 10000, "type": "string" }, "id": { "description": "Custom geo collection ID.", "example": "my-geo-collection", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "name": { "description": "Name of the custom geo collection.", "example": "My Geo Collection", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": "object" }, "DeclarativeCustomGeoCollections": { "description": "Custom geo collections.", "properties": { "customGeoCollections": { "items": { "$ref": "#/components/schemas/DeclarativeCustomGeoCollection" }, "type": "array" } }, "required": [ "customGeoCollections" ], "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": { "alternativeDataSourceId": { "description": "Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source.", "example": "pg_local_docker-demo2", "nullable": true, "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "authenticationType": { "description": "Type of authentication used to connect to the database.", "enum": [ "USERNAME_PASSWORD", "TOKEN", "KEY_PAIR", "CLIENT_SECRET", "OIDC_PASSTHROUGH" ], "nullable": true, "type": "string" }, "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" }, "clientId": { "description": "Id of client with permission to connect to the data source.", "example": "client1234", "maxLength": 255, "type": "string" }, "clientSecret": { "description": "The client secret to use to connect to the database providing the data for the data source.", "maxLength": 255, "type": "string" }, "dateTimeSemantics": { "description": "Determines how datetime values are interpreted in data sources without native support for specifying this.\n- LOCAL: The values are assumed to be in local timezone and they are not converted to the user's timezone.\n- UTC: The values are assumed to be in UTC and they are converted to the user's timezone.", "enum": [ "LOCAL", "UTC" ], "nullable": true, "type": "string" }, "decodedParameters": { "items": { "$ref": "#/components/schemas/Parameter" }, "type": "array" }, "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" }, "privateKey": { "description": "The private key to use to connect to the database providing the data for the data source.", "maxLength": 15000, "nullable": true, "type": "string" }, "privateKeyPassphrase": { "description": "The passphrase used to encrypt the private key.", "maxLength": 255, "nullable": true, "type": "string" }, "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", "ORACLE", "PINOT", "SINGLESTORE", "MOTHERDUCK", "FLEXCONNECT", "STARROCKS", "ATHENA", "MONGODB", "CRATEDB", "AILAKEHOUSE", "DENODO" ], "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": { "aggregatedFacts": { "description": "An array of aggregated facts. Presence makes the dataset a pre-aggregation dataset, which requires `precedence > 0` and must NOT be set on AUXILIARY datasets.", "items": { "$ref": "#/components/schemas/DeclarativeAggregatedFact" }, "type": "array" }, "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" }, "precedence": { "description": "Precedence used in aggregate awareness. Pre-aggregation datasets (NORMAL with `aggregatedFacts`) MUST set `precedence > 0`; non-pre-aggregation datasets MUST leave it null. Must NOT be set on AUXILIARY datasets.", "example": 0, "format": "int32", "minimum": 0, "type": "integer" }, "references": { "description": "An array of references. The semantics of `sources` depends on the dataset shape: for NORMAL\u2192NORMAL references, `sources` is a compound foreign key to the target dataset's grain (one source per grain component, dataType-matched). For pre-aggregation datasets (NORMAL with `aggregatedFacts`), `sources` is reinterpreted as independent column\u2192attribute mappings \u2014 one entry per source \u2014 and targets are NOT required to be grain components.", "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" }, "type": { "description": "Dataset type. NORMAL is the standard fact/dim dataset. AUXILIARY denotes a synthetic dataset used as a reference target by pre-aggregation datasets (keystone of the aggregate-awareness design); AUX datasets must not carry `aggregatedFacts`, `sql`, `dataSourceTableId`, `workspaceDataFilterReferences` or `precedence`. Date datasets use a separate schema and are not represented by this enum.", "enum": [ "NORMAL", "AUXILIARY" ], "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. Must NOT be set on AUXILIARY datasets.", "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. Must NOT be set on AUXILIARY datasets.", "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_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_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" }, "DeclarativeExportDefinition": { "properties": { "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": "Export definition object description.", "example": "Simple number for total goods in current production.", "maxLength": 10000, "type": "string" }, "id": { "description": "Export definition id.", "example": "export-definition-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" }, "requestPayload": { "oneOf": [ { "$ref": "#/components/schemas/TabularExportRequest" }, { "$ref": "#/components/schemas/VisualExportRequest" } ] }, "tags": { "description": "A list of tags.", "example": [ "Revenues" ], "items": { "description": "A list of tags.", "example": "[\"Revenues\"]", "type": "string" }, "type": "array", "uniqueItems": true }, "title": { "description": "Export definition object title.", "example": "My regular export", "maxLength": 255, "type": "string" } }, "required": [ "id", "title" ], "type": "object" }, "DeclarativeExportDefinitionIdentifier": { "description": "An export definition identifier.", "properties": { "id": { "description": "Export definition identifier.", "example": "export123", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "A type.", "enum": [ "exportDefinition" ], "example": "exportDefinition", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "DeclarativeExportTemplate": { "description": "A declarative form of a particular export template.", "properties": { "dashboardSlidesTemplate": { "$ref": "#/components/schemas/DashboardSlidesTemplate" }, "id": { "description": "Identifier of an export template", "example": "default-export-template", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "name": { "description": "Name of an export template.", "example": "My default export template", "maxLength": 255, "type": "string" }, "widgetSlidesTemplate": { "$ref": "#/components/schemas/WidgetSlidesTemplate" } }, "required": [ "id", "name" ], "type": "object" }, "DeclarativeExportTemplates": { "description": "Export templates.", "properties": { "exportTemplates": { "items": { "$ref": "#/components/schemas/DeclarativeExportTemplate" }, "type": "array" } }, "required": [ "exportTemplates" ], "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" }, "isHidden": { "description": "If true, this fact is hidden from AI search results.", "example": false, "type": "boolean" }, "isNullable": { "description": "Flag indicating whether the associated source column allows null values.", "example": false, "type": "boolean" }, "nullValue": { "description": "Value used in coalesce during joins instead of null.", "example": "0", "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", "HLL" ], "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", "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" }, "DeclarativeFilterView": { "properties": { "analyticalDashboard": { "$ref": "#/components/schemas/DeclarativeAnalyticalDashboardIdentifier" }, "content": { "$ref": "#/components/schemas/JsonNode" }, "description": { "maxLength": 255, "type": "string" }, "id": { "description": "FilterView object ID.", "example": "filterView-1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "isDefault": { "description": "Indicator whether the filter view should by applied by default.", "type": "boolean" }, "tags": { "items": { "description": "A list of tags.", "example": "[\"Revenue\",\"Sales\"]", "type": "string" }, "type": "array", "uniqueItems": true }, "title": { "maxLength": 255, "type": "string" }, "user": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" } }, "required": [ "id", "title" ], "type": "object" }, "DeclarativeIdentityProvider": { "description": "Notification channels.", "properties": { "customClaimMapping": { "additionalProperties": { "type": "string" }, "description": "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.", "maxLength": 10000, "type": "object" }, "id": { "description": "FilterView object ID.", "example": "filterView-1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "identifiers": { "description": "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.", "example": [ "gooddata.com" ], "items": { "description": "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.", "example": "[\"gooddata.com\"]", "type": "string" }, "type": "array" }, "idpType": { "description": "Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.", "enum": [ "MANAGED_IDP", "FIM_IDP", "DEX_IDP", "CUSTOM_IDP" ], "type": "string" }, "oauthClientId": { "description": "The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.", "maxLength": 255, "type": "string" }, "oauthClientSecret": { "description": "The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.", "maxLength": 255, "type": "string" }, "oauthCustomAuthAttributes": { "additionalProperties": { "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", "maxLength": 10000, "type": "string" }, "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", "maxLength": 10000, "type": "object" }, "oauthCustomScopes": { "description": "List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", "items": { "maxLength": 255, "type": "string" }, "nullable": true, "type": "array" }, "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": "The location of your OIDC provider. This field is mandatory for OIDC IdP.", "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" }, "samlMetadata": { "description": "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.", "maxLength": 15000, "type": "string" } }, "required": [ "id" ], "type": "object" }, "DeclarativeIdentityProviderIdentifier": { "description": "An Identity Provider identifier.", "properties": { "id": { "description": "Identifier of the identity provider.", "example": "gooddata.com", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "A type.", "enum": [ "identityProvider" ], "example": "identityProvider", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "DeclarativeIpAllowlistPolicy": { "description": "A declarative form of an IP allowlist policy.", "properties": { "allowedSources": { "description": "Allowed source IPv4 addresses or CIDR ranges. Only IPv4 is supported; IPv6 are rejected. The /0 prefix is not allowed.", "example": [ "203.0.113.10/32", "198.51.100.0/24" ], "items": { "description": "Allowed source IPv4 addresses or CIDR ranges. Only IPv4 is supported; IPv6 are rejected. The /0 prefix is not allowed.", "example": "[\"203.0.113.10/32\",\"198.51.100.0/24\"]", "type": "string" }, "type": "array" }, "id": { "description": "Identifier of an IP allowlist policy.", "example": "admin-vpn-only", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "userGroups": { "description": "Target user groups this policy applies to.", "items": { "$ref": "#/components/schemas/DeclarativeUserGroupIdentifier" }, "type": "array" }, "users": { "description": "Target users this policy applies to.", "items": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, "type": "array" } }, "required": [ "allowedSources", "id" ], "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" }, "geoAreaConfig": { "$ref": "#/components/schemas/GeoAreaConfig" }, "id": { "description": "Label ID.", "example": "label.customer_name", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "isHidden": { "description": "Determines if the label is hidden from AI features.", "example": false, "type": "boolean" }, "isNullable": { "description": "Flag indicating whether the associated source column allows null values.", "example": false, "type": "boolean" }, "locale": { "description": "Default label locale.", "example": "en-US", "type": "string" }, "nullValue": { "description": "Value used in coalesce during joins instead of null.", "example": "empty_value", "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", "HLL" ], "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" }, "translations": { "description": "Other translations.", "items": { "$ref": "#/components/schemas/DeclarativeLabelTranslation" }, "type": "array" }, "valueType": { "description": "Specific type of label", "enum": [ "TEXT", "HYPERLINK", "GEO", "GEO_LONGITUDE", "GEO_LATITUDE", "GEO_AREA", "GEO_ICON", "IMAGE", "HYPERLOGLOG" ], "type": "string" } }, "required": [ "id", "title" ], "type": "object" }, "DeclarativeLabelTranslation": { "description": "A label translation.", "properties": { "locale": { "description": "Translation locale.", "example": "en-US", "type": "string" }, "sourceColumn": { "description": "Translation source column.", "example": "customer_name_en", "type": "string" } }, "required": [ "locale", "sourceColumn" ], "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" }, "DeclarativeMemoryItem": { "properties": { "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": "Memory item description.", "example": "Context about sales data for AI assistant.", "maxLength": 10000, "type": "string" }, "id": { "description": "Memory item ID.", "example": "sales-context", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "instruction": { "description": "The text that will be injected into the system prompt.", "example": "When discussing sales, always consider quarterly trends.", "maxLength": 255, "type": "string" }, "isDisabled": { "description": "Whether memory item is disabled.", "example": false, "type": "boolean" }, "keywords": { "description": "Set of unique strings used for semantic similarity filtering.", "items": { "type": "string" }, "type": "array", "uniqueItems": true }, "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" }, "strategy": { "description": "Strategy defining when the memory item should be applied", "enum": [ "ALWAYS", "AUTO" ], "example": "AUTO", "type": "string" }, "tags": { "description": "A list of tags.", "example": [ "AI", "Context" ], "items": { "description": "A list of tags.", "example": "[\"AI\",\"Context\"]", "type": "string" }, "type": "array", "uniqueItems": true }, "title": { "description": "Memory item title.", "example": "Sales Context", "maxLength": 255, "type": "string" } }, "required": [ "id", "instruction", "strategy", "title" ], "type": "object" }, "DeclarativeMetric": { "properties": { "certification": { "description": "Certification status of the entity.", "enum": [ "CERTIFIED" ], "type": "string" }, "certificationMessage": { "description": "Optional message associated with the certification.", "nullable": true, "type": "string" }, "certifiedAt": { "description": "Time when the certification was set.", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "certifiedBy": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, "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" }, "isHidden": { "description": "If true, this metric is hidden from AI search results.", "example": false, "type": "boolean" }, "isHiddenFromKda": { "description": "If true, this metric is hidden from key drive analysis.", "example": false, "type": "boolean" }, "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" }, "DeclarativeNotificationChannel": { "description": "A declarative form of a particular notification channel.", "properties": { "allowedRecipients": { "default": "INTERNAL", "description": "Allowed recipients of notifications from this channel.\nCREATOR - only the creator\nINTERNAL - all users within the organization\nEXTERNAL - all recipients including those outside the organization\n", "enum": [ "CREATOR", "INTERNAL", "EXTERNAL" ], "type": "string" }, "customDashboardUrl": { "description": "Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are:\n{workspaceId}\n{dashboardId}\n{automationId}\n{asOfDate}\n", "maxLength": 255, "type": "string" }, "dashboardLinkVisibility": { "default": "INTERNAL_ONLY", "description": "Dashboard link visibility in notifications.\nHIDDEN - the link will not be included\nINTERNAL_ONLY - only internal users will see the link\nALL - all users will see the link\n", "enum": [ "HIDDEN", "INTERNAL_ONLY", "ALL" ], "type": "string" }, "description": { "description": "Description of a notification channel.", "example": "This is a channel", "maxLength": 10000, "type": "string" }, "destination": { "oneOf": [ { "$ref": "#/components/schemas/DefaultSmtp" }, { "$ref": "#/components/schemas/InPlatform" }, { "$ref": "#/components/schemas/Smtp" }, { "$ref": "#/components/schemas/Webhook" } ] }, "destinationType": { "enum": [ "WEBHOOK", "SMTP", "DEFAULT_SMTP", "IN_PLATFORM" ], "nullable": true, "readOnly": true, "type": "string" }, "id": { "description": "Identifier of a notification channel", "example": "notification-channel-1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "inPlatformNotification": { "default": "DISABLED", "description": "In-platform notifications configuration. No effect if the destination type is IN_PLATFORM.\nDISABLED - in-platform notifications are not sent\nENABLED - in-platform notifications are sent in addition to the regular notifications\n", "enum": [ "DISABLED", "ENABLED" ], "type": "string" }, "name": { "description": "Name of a notification channel.", "example": "channel", "maxLength": 255, "type": "string" }, "notificationSource": { "description": "Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are:\n{{workspaceId}}\n{{workspaceName}}\n{{workspaceDescription}}\n{{dashboardId}}\n{{dashboardName}}\n{{dashboardDescription}}\n", "maxLength": 10000, "type": "string" } }, "required": [ "id" ], "type": "object" }, "DeclarativeNotificationChannelIdentifier": { "description": "A notification channel identifier.", "properties": { "id": { "description": "Notification channel identifier.", "example": "webhook123", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "A type.", "enum": [ "notificationChannel" ], "example": "notificationChannel", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "DeclarativeNotificationChannels": { "description": "Notification channels.", "properties": { "notificationChannels": { "items": { "$ref": "#/components/schemas/DeclarativeNotificationChannel" }, "type": "array" } }, "required": [ "notificationChannels" ], "type": "object" }, "DeclarativeOrganization": { "description": "Complete definition of an organization in a declarative form.", "properties": { "agents": { "items": { "$ref": "#/components/schemas/DeclarativeAgent" }, "type": "array" }, "customGeoCollections": { "items": { "$ref": "#/components/schemas/DeclarativeCustomGeoCollection" }, "type": "array" }, "dataSources": { "items": { "$ref": "#/components/schemas/DeclarativeDataSource" }, "type": "array" }, "exportTemplates": { "items": { "$ref": "#/components/schemas/DeclarativeExportTemplate" }, "type": "array" }, "identityProviders": { "items": { "$ref": "#/components/schemas/DeclarativeIdentityProvider" }, "type": "array" }, "ipAllowlistPolicies": { "items": { "$ref": "#/components/schemas/DeclarativeIpAllowlistPolicy" }, "type": "array" }, "jwks": { "items": { "$ref": "#/components/schemas/DeclarativeJwk" }, "type": "array" }, "notificationChannels": { "items": { "$ref": "#/components/schemas/DeclarativeNotificationChannel" }, "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": { "allowedOrigins": { "items": { "type": "string" }, "type": "array" }, "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": { "deprecated": true, "description": "Early access defined on level Organization", "maxLength": 255, "type": "string" }, "earlyAccessValues": { "description": "Early access defined on level Organization", "items": { "maxLength": 255, "type": "string" }, "type": "array", "uniqueItems": true }, "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" }, "identityProvider": { "$ref": "#/components/schemas/DeclarativeIdentityProviderIdentifier" }, "name": { "description": "Formal name of the organization.", "example": "Alpha corporation", "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", "BASE_UI_ACCESS" ], "type": "string" } }, "required": [ "assignee", "name" ], "type": "object" }, "DeclarativeParameter": { "properties": { "content": { "discriminator": { "mapping": { "NUMBER": "#/components/schemas/NumberParameterDefinition", "STRING": "#/components/schemas/StringParameterDefinition" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/NumberParameterDefinition" }, { "$ref": "#/components/schemas/StringParameterDefinition" } ] }, "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": "Parameter description.", "example": "Rate applied to discounted items.", "maxLength": 10000, "type": "string" }, "id": { "description": "Parameter ID.", "example": "discount-rate", "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": [ "Finance" ], "items": { "description": "A list of tags.", "example": "[\"Finance\"]", "type": "string" }, "type": "array", "uniqueItems": true }, "title": { "description": "Parameter title.", "example": "Discount Rate", "maxLength": 255, "type": "string" } }, "required": [ "content", "id", "title" ], "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", "HLL" ], "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", "HLL" ], "example": "STRING", "maxLength": 255, "type": "string" }, "isNullable": { "description": "Flag indicating whether the associated source column allows null values.", "example": false, "type": "boolean" }, "nullValue": { "description": "Value used in coalesce during joins instead of null.", "example": "empty_value", "type": "string" }, "target": { "$ref": "#/components/schemas/GrainIdentifier" } }, "required": [ "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", "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", "GEO_ICON_SHEET", "AG_GRID_TOKEN", "WEEK_START", "FISCAL_YEAR", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", "ALERT", "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", "ENABLE_DRILL_TO_URL_BY_DEFAULT", "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", "ENABLE_AUTOMATION_EVALUATION_MODE", "ENABLE_ACCESSIBILITY_MODE", "REGISTERED_PLUGGABLE_APPLICATIONS", "DATA_LOCALE", "LDM_DEFAULT_LOCALE", "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", "CERTIFY_PARENT_OBJECTS", "HLL_TYPE" ], "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", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", "WRITE_KNOWLEDGE_DOCUMENTS", "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "VIEW" ], "type": "string" } }, "required": [ "assignee", "name" ], "type": "object" }, "DeclarativeSourceReference": { "description": "Source object reference (attribute or fact) including aggregation operation.", "properties": { "operation": { "description": "Aggregation operation.", "enum": [ "SUM", "MIN", "MAX", "APPROXIMATE_COUNT" ], "example": "SUM", "type": "string" }, "reference": { "$ref": "#/components/schemas/SourceReferenceIdentifier" } }, "required": [ "operation", "reference" ], "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" }, "systemAccount": { "description": "Is user system account", "example": false, "type": "boolean" }, "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": { "certification": { "description": "Certification status of the entity.", "enum": [ "CERTIFIED" ], "type": "string" }, "certificationMessage": { "description": "Optional message associated with the certification.", "nullable": true, "type": "string" }, "certifiedAt": { "description": "Time when the certification was set.", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "certifiedBy": { "$ref": "#/components/schemas/DeclarativeUserIdentifier" }, "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" }, "isHidden": { "description": "If true, this visualization object is hidden from AI search results.", "example": false, "type": "boolean" }, "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": { "automations": { "items": { "$ref": "#/components/schemas/DeclarativeAutomation" }, "type": "array" }, "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" }, "dataSource": { "$ref": "#/components/schemas/WorkspaceDataSource" }, "description": { "description": "Description of the workspace", "maxLength": 255, "type": "string" }, "earlyAccess": { "deprecated": true, "description": "Early access defined on level Workspace", "maxLength": 255, "type": "string" }, "earlyAccessValues": { "description": "Early access defined on level Workspace", "items": { "maxLength": 255, "type": "string" }, "type": "array", "uniqueItems": true }, "filterViews": { "items": { "$ref": "#/components/schemas/DeclarativeFilterView" }, "type": "array" }, "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", "workspace", "workspaceDataFilterSettings" ], "type": "object" }, "DeclarativeWorkspaceDataFilterColumn": { "properties": { "dataType": { "description": "Data type of the column", "enum": [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN", "HLL" ], "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", "HLL" ], "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", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", "WRITE_KNOWLEDGE_DOCUMENTS", "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "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" }, "DefaultSmtp": { "allOf": [ { "properties": { "fromEmail": { "default": "no-reply@gooddata.com", "description": "E-mail address to send notifications from. Currently this does not have any effect. E-mail 'no-reply@gooddata.com' is used instead.", "format": "email", "type": "string" }, "fromEmailName": { "default": "GoodData", "description": "An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name 'GoodData' is used instead.", "type": "string" }, "type": { "description": "The destination type.", "enum": [ "DEFAULT_SMTP" ], "type": "string" } }, "type": "object" } ], "description": "Default SMTP destination for notifications.", "properties": { "fromEmail": { "default": "no-reply@gooddata.com", "description": "E-mail address to send notifications from. Currently this does not have any effect. E-mail 'no-reply@gooddata.com' is used instead.", "format": "email", "type": "string" }, "fromEmailName": { "default": "GoodData", "description": "An optional e-mail name to send notifications from. Currently this does not have any effect. E-mail from name 'GoodData' is used instead.", "type": "string" }, "type": { "description": "The destination type.", "enum": [ "DEFAULT_SMTP" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "DeleteFilesRequest": { "description": "Request to delete files from the storage.", "properties": { "fileNames": { "description": "Names of the files to delete.", "items": { "description": "Names of the files to delete.", "type": "string" }, "type": "array" } }, "required": [ "fileNames" ], "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": { "description": "Object type in the graph.", "enum": [ "analyticalDashboard", "attribute", "attributeHierarchy", "dashboardPlugin", "dataset", "fact", "label", "metric", "userDataFilter", "parameter", "automation", "memoryItem", "knowledgeRecommendation", "visualizationObject", "filterContext", "filterView" ], "example": "metric", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "DependentEntitiesRequest": { "properties": { "identifiers": { "items": { "$ref": "#/components/schemas/EntityIdentifier" }, "type": "array" }, "relation": { "default": "DEPENDENTS", "description": "Entity relation for graph traversal from the entry points. DEPENDENTS returns entities that depend on the entry points. DEPENDENCIES returns entities that the entry points depend on.", "enum": [ "DEPENDENTS", "DEPENDENCIES" ], "type": "string" } }, "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" }, "DependsOnMatchFilter": { "allOf": [ { "$ref": "#/components/schemas/DependsOnItem" }, { "properties": { "matchFilter": { "$ref": "#/components/schemas/MatchAttributeFilter" } }, "type": "object" } ], "description": "Filter definition for string matching.", "required": [ "matchFilter" ], "type": "object" }, "DimAttribute": { "description": "List of attributes representing the dimensionality of the new visualization", "properties": { "id": { "description": "ID of the object", "example": "country", "type": "string" }, "title": { "description": "Title of attribute.", "type": "string" }, "type": { "description": "Object type", "enum": [ "attribute" ], "example": "attribute", "type": "string" } }, "required": [ "id", "title", "type" ], "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" }, "DistributionConfig": { "description": "Distribution configuration for the OLAP table.", "discriminator": { "mapping": { "hash": "#/components/schemas/HashDistributionConfig", "random": "#/components/schemas/RandomDistributionConfig" }, "propertyName": "type" }, "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "DuplicateKeyConfig": { "description": "Duplicate key model \u2014 allows duplicate rows for the given key columns.", "properties": { "columns": { "description": "Key columns. Defaults to first inferred column.", "items": { "description": "Key columns. Defaults to first inferred column.", "type": "string" }, "type": "array" } }, "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": { "cacheId": { "description": "If specified, the element data will be taken from the result with the same cacheId if it is available.", "type": "string" }, "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.0, "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 that are not filtered-out by the parent filters.", "items": { "oneOf": [ { "$ref": "#/components/schemas/DependsOn" }, { "$ref": "#/components/schemas/DependsOnDateFilter" }, { "$ref": "#/components/schemas/DependsOnMatchFilter" } ] }, "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 that 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": { "cacheId": { "description": "The client can use this in subsequent requests (like paging or search) to get results from the same point in time as the previous request. This is useful when the underlying data source has caches disabled and the client wants to avoid seeing inconsistent results and to also avoid excessive queries to the database itself.", "type": "string" }, "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_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR" ], "type": "string" }, "paging": { "$ref": "#/components/schemas/Paging" }, "primaryLabel": { "$ref": "#/components/schemas/RestApiIdentifier" } }, "required": [ "elements", "paging", "primaryLabel" ], "type": "object" }, "EmptyValueHandling": { "enum": [ "INCLUDE", "EXCLUDE", "ONLY" ], "title": "EmptyValueHandling", "type": "string" }, "EntitlementsRequest": { "properties": { "entitlementsName": { "items": { "enum": [ "CacheStrategy", "Contract", "CustomTheming", "ExtraCache", "Hipaa", "PdfExports", "UiLocalization", "Tier", "UserCount", "ManagedIdpUserCount", "UnlimitedUsers", "UnlimitedWorkspaces", "WhiteLabeling", "WorkspaceCount", "UserTelemetryDisabled", "AutomationCount", "UnlimitedAutomations", "AutomationRecipientCount", "UnlimitedAutomationRecipients", "DailyScheduledActionCount", "UnlimitedDailyScheduledActions", "DailyAlertActionCount", "UnlimitedDailyAlertActions", "ScheduledActionMinimumRecurrenceMinutes", "FederatedIdentityManagement", "AuditLogging", "ControlledFeatureRollout", "AiLake", "AiModule", "AiQueryLimit", "AiKnowledgeStorageLimit", "AiAgentLimit", "AiWorkspaceLimit", "AiObservability" ], "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": { "description": "Object type in the graph.", "enum": [ "analyticalDashboard", "attribute", "attributeHierarchy", "dashboardPlugin", "dataset", "fact", "label", "metric", "userDataFilter", "parameter", "automation", "memoryItem", "knowledgeRecommendation", "visualizationObject", "filterContext", "filterView" ], "example": "metric", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "EntitySearchBody": { "description": "Request body for entity search operations", "properties": { "filter": { "description": "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').", "nullable": true, "type": "string" }, "include": { "description": "List of related entities to include in the response", "items": { "type": "string" }, "nullable": true, "type": "array" }, "metaInclude": { "description": "Set of metadata fields to include in the response", "items": { "type": "string" }, "nullable": true, "type": "array", "uniqueItems": true }, "page": { "$ref": "#/components/schemas/EntitySearchPage" }, "sort": { "description": "Sorting criteria (can specify multiple sort orders)", "items": { "$ref": "#/components/schemas/EntitySearchSort" }, "nullable": true, "type": "array" } }, "type": "object" }, "EntitySearchPage": { "description": "Pagination information for entity search", "properties": { "index": { "default": 0, "description": "Zero-based page index", "format": "int32", "minimum": 0, "type": "integer" }, "size": { "default": 100, "description": "Number of items per page", "format": "int32", "minimum": 1, "type": "integer" } }, "required": [ "index", "size" ], "type": "object" }, "EntitySearchSort": { "description": "Sorting criteria for entity search", "properties": { "direction": { "default": "ASC", "description": "Sort direction", "enum": [ "ASC", "DESC" ], "type": "string" }, "property": { "description": "Property name to sort by", "type": "string" } }, "required": [ "property" ], "type": "object" }, "ErrorInfo": { "description": "Structured error, present when the search could not run (e.g. metadata sync in progress). Absent on success.", "properties": { "reason": { "description": "Stable machine-readable error code. Switch on this for localized client messages.", "example": "METADATA_SYNC_IN_PROGRESS", "type": "string" }, "statusCode": { "description": "HTTP-like semantic status (e.g. 503 when the workspace is still syncing).", "example": 503, "format": "int32", "type": "integer" } }, "required": [ "reason", "statusCode" ], "type": "object" }, "ExecutionLinks": { "description": "Links to the execution result.", "properties": { "executionResult": { "description": "Link to the result data.", "type": "string" } }, "required": [ "executionResult" ], "type": "object" }, "ExecutionResponse": { "description": "Response to AFM execution request body", "properties": { "dimensions": { "description": "Dimensions of the result", "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.0, 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" }, "metadata": { "$ref": "#/components/schemas/ExecutionResultMetadata" }, "paging": { "$ref": "#/components/schemas/ExecutionResultPaging" } }, "required": [ "data", "dimensionHeaders", "grandTotals", "metadata", "paging" ], "type": "object" }, "ExecutionResultDataSourceMessage": { "description": "A piece of extra information related to the results (e.g. debug information, warnings, etc.).", "properties": { "correlationId": { "description": "Id correlating different pieces of supplementary info together.", "type": "string" }, "data": { "description": "Data of this particular supplementary info item: a free-form JSON specific to the particular supplementary info item type.", "type": "object" }, "source": { "description": "Information about what part of the system created this piece of supplementary info.", "type": "string" }, "type": { "description": "Type of the supplementary info instance. There are currently no well-known values for this, but there might be some in the future.", "type": "string" } }, "required": [ "correlationId", "source", "type" ], "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.0, 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" }, "ExecutionResultLimitBreak": { "description": "Describes a limit that was broken, resulting in partial data being returned.", "properties": { "limit": { "description": "The configured threshold value.", "format": "int64", "type": "integer" }, "limitType": { "description": "Type of the limit that was broken, e.g. \"rowCount\".", "type": "string" }, "value": { "description": "The actual value that triggered the limit; null when it cannot be determined exactly.", "format": "int64", "type": "integer" } }, "required": [ "limit", "limitType" ], "type": "object" }, "ExecutionResultMetadata": { "description": "Additional metadata for the particular execution result.", "properties": { "dataSourceMessages": { "description": "Additional information sent by the underlying data source.", "items": { "$ref": "#/components/schemas/ExecutionResultDataSourceMessage" }, "type": "array" }, "limitBreaks": { "description": "Limits that were broken during result computation, causing the result to be partial. Absent when the result is complete.", "items": { "$ref": "#/components/schemas/ExecutionResultLimitBreak" }, "type": "array" } }, "required": [ "dataSourceMessages" ], "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" }, "timestamp": { "description": "Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.", "format": "date-time", "type": "string" } }, "type": "object" }, "ExportRequest": { "description": "JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. ", "example": [ "Revenues" ], "oneOf": [ { "$ref": "#/components/schemas/VisualExportRequest" }, { "$ref": "#/components/schemas/TabularExportRequest" } ], "type": "object" }, "ExportResponse": { "properties": { "exportResult": { "type": "string" } }, "required": [ "exportResult" ], "type": "object" }, "ExportResult": { "properties": { "errorMessage": { "type": "string" }, "expiresAt": { "format": "date-time", "type": "string" }, "exportId": { "type": "string" }, "fileName": { "type": "string" }, "fileSize": { "format": "int64", "type": "integer" }, "fileUri": { "type": "string" }, "finishedAt": { "format": "date-time", "type": "string" }, "status": { "enum": [ "SUCCESS", "ERROR", "INTERNAL_ERROR", "TIMEOUT" ], "type": "string" }, "traceId": { "type": "string" }, "triggeredAt": { "format": "date-time", "type": "string" } }, "required": [ "exportId", "fileName", "status" ], "type": "object" }, "FailedOperation": { "allOf": [ { "$ref": "#/components/schemas/Operation" }, { "properties": { "error": { "$ref": "#/components/schemas/OperationError" } }, "type": "object" } ], "description": "Operation that has failed", "required": [ "error", "id", "kind" ], "type": "object" }, "FeatureFlagsContext": { "properties": { "earlyAccess": { "type": "string" }, "earlyAccessValues": { "items": { "type": "string" }, "type": "array", "uniqueItems": true } }, "required": [ "earlyAccess", "earlyAccessValues" ], "type": "object" }, "Features": { "description": "Base Structure for feature flags", "properties": { "context": { "$ref": "#/components/schemas/FeatureFlagsContext" } }, "required": [ "context" ], "type": "object" }, "Feedback": { "additionalProperties": false, "properties": { "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional free-form feedback comment.", "title": "Text" }, "type": { "description": "Feedback type.", "enum": [ "POSITIVE", "NEGATIVE" ], "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "Feedback", "type": "object" }, "File": { "properties": { "any": { "items": { "type": "object" }, "type": "array" }, "canResegment": { "enum": [ "YES", "NO" ], "type": "string" }, "id": { "type": "string" }, "notes": { "$ref": "#/components/schemas/Notes" }, "original": { "type": "string" }, "otherAttributes": { "additionalProperties": { "type": "string" }, "type": "object" }, "skeleton": { "$ref": "#/components/schemas/Skeleton" }, "space": { "type": "string" }, "srcDir": { "enum": [ "LTR", "RTL", "AUTO" ], "type": "string" }, "translate": { "enum": [ "YES", "NO" ], "type": "string" }, "trgDir": { "enum": [ "LTR", "RTL", "AUTO" ], "type": "string" }, "unitOrGroup": { "items": { "type": "object" }, "type": "array" } }, "type": "object" }, "Filter": { "description": "List of filters to be applied to the new visualization", "type": "object" }, "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/CompoundMeasureValueFilter" }, { "$ref": "#/components/schemas/AbsoluteDateFilter" }, { "$ref": "#/components/schemas/RelativeDateFilter" }, { "$ref": "#/components/schemas/AllTimeDateFilter" }, { "$ref": "#/components/schemas/NegativeAttributeFilter" }, { "$ref": "#/components/schemas/PositiveAttributeFilter" }, { "$ref": "#/components/schemas/MatchAttributeFilter" } ], "type": "object" }, "FilterDefinitionForSimpleMeasure": { "description": "Abstract filter definition type for simple metric.", "oneOf": [ { "$ref": "#/components/schemas/DateFilter" }, { "$ref": "#/components/schemas/AttributeFilter" } ], "type": "object" }, "ForecastConfig": { "description": "Forecast configuration.", "properties": { "confidenceLevel": { "description": "Confidence interval boundary value.", "format": "float", "type": "number" }, "forecastPeriod": { "description": "Number of future periods that should be forecasted", "format": "int32", "type": "integer" }, "seasonal": { "description": "Whether the input data is seasonal", "type": "boolean" } }, "required": [ "confidenceLevel", "forecastPeriod", "seasonal" ], "type": "object" }, "ForecastRequest": { "properties": { "confidenceLevel": { "default": 0.95, "description": "Confidence interval boundary value.", "exclusiveMaximum": true, "exclusiveMinimum": true, "format": "float", "maximum": 1.0, "minimum": 0.0, "type": "number" }, "forecastPeriod": { "description": "Number of future periods that should be forecasted", "format": "int32", "type": "integer" }, "seasonal": { "default": false, "description": "Whether the input data is seasonal", "type": "boolean" } }, "required": [ "forecastPeriod" ], "type": "object" }, "ForecastResult": { "properties": { "attribute": { "items": { "type": "string" }, "type": "array" }, "lowerBound": { "items": { "nullable": true, "type": "number" }, "type": "array" }, "origin": { "items": { "nullable": true, "type": "number" }, "type": "array" }, "prediction": { "items": { "nullable": true, "type": "number" }, "type": "array" }, "upperBound": { "items": { "nullable": true, "type": "number" }, "type": "array" } }, "required": [ "attribute", "lowerBound", "origin", "prediction", "upperBound" ], "type": "object" }, "FoundObjects": { "description": "List of objects found by similarity search and post-processed by LLM.", "properties": { "objects": { "description": "List of objects found with a similarity search.", "items": { "$ref": "#/components/schemas/SearchResultObject" }, "type": "array" }, "reasoning": { "description": "DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated.", "type": "string" } }, "required": [ "objects", "reasoning" ], "type": "object" }, "Frequency": { "properties": { "buckets": { "items": { "$ref": "#/components/schemas/FrequencyBucket" }, "type": "array" } }, "required": [ "buckets" ], "type": "object" }, "FrequencyBucket": { "properties": { "count": { "format": "int64", "type": "integer" }, "value": { "type": "string" } }, "required": [ "count" ], "type": "object" }, "FrequencyProperties": { "properties": { "valueLimit": { "default": 10, "description": "The maximum number of distinct values to return.", "format": "int32", "type": "integer" } }, "type": "object" }, "FunctionCallContent": { "additionalProperties": false, "properties": { "arguments": { "additionalProperties": true, "description": "Function/tool arguments payload.", "title": "Arguments", "type": "object" }, "callId": { "description": "Function call correlation identifier.", "title": "Callid", "type": "string" }, "id": { "description": "Function call item identifier from LLM.", "title": "Id", "type": "string" }, "name": { "description": "Function/tool name.", "title": "Name", "type": "string" }, "type": { "const": "toolCall", "default": "toolCall", "description": "Type of item content.", "title": "Type", "type": "string" } }, "required": [ "id", "callId", "name", "arguments" ], "title": "FunctionCallContent", "type": "object" }, "FunctionResultContent": { "additionalProperties": false, "properties": { "callId": { "description": "Function call correlation identifier.", "title": "Callid", "type": "string" }, "result": { "description": "Serialized function/tool execution result.", "title": "Result", "type": "string" }, "type": { "const": "toolResult", "default": "toolResult", "description": "Type of item content.", "title": "Type", "type": "string" } }, "required": [ "callId", "result" ], "title": "FunctionResultContent", "type": "object" }, "GdStorageFile": { "description": "File stored in GD Storage.", "properties": { "modifiedAt": { "description": "Last modification timestamp of the file.", "format": "date-time", "type": "string" }, "name": { "description": "Name of the file.", "type": "string" }, "size": { "description": "Size of the file in bytes.", "format": "int64", "type": "integer" }, "type": { "description": "Type of the file.", "enum": [ "CSV" ], "type": "string" } }, "required": [ "modifiedAt", "name", "size", "type" ], "type": "object" }, "GenerateDescriptionRequest": { "properties": { "objectId": { "description": "Identifier of the object to describe", "type": "string" }, "objectType": { "description": "Type of the object to describe. One of: visualization, dashboard, metric, fact, attribute", "enum": [ "Visualization", "Dashboard", "Metric", "Fact", "Attribute" ], "type": "string" } }, "required": [ "objectId", "objectType" ], "type": "object" }, "GenerateDescriptionResponse": { "properties": { "description": { "description": "Generated description of the requested object", "type": "string" }, "note": { "description": "Additional note with details in case generation was not performed", "type": "string" } }, "type": "object" }, "GenerateLdmRequest": { "description": "A request containing all information needed for generation of logical model.", "properties": { "aggregatedFactPrefix": { "description": "Columns starting with this prefix will be considered as aggregated facts. The prefix is then followed by the value of `separator` parameter. Given the aggregated fact prefix is `aggr` and separator is `__`, the columns with name like `aggr__sum__product__sold` will be considered as aggregated sold fact in the product table with SUM aggregate function.", "example": "aggr", "type": "string" }, "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" }, "dateReferencePrefix": { "description": "Columns starting with this prefix will be considered as references to date dataset. The prefix is then followed by the value of `separator` parameter. Given the reference prefix is `d` and separator is `__`, the columns with name like `d__date` will be considered as reference to date dataset. There can be also second separator and granularity suffix, e.g. `d__date__day` to create attribute reference to exact date dataset and granularity.", "example": "d", "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": { "default": false, "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 `.` is used. If the flag is set to true, then all ids will be generated in the long form.", "type": "boolean" }, "grainMultivalueReferencePrefix": { "description": "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.", "example": "grmr", "type": "string" }, "grainPrefix": { "description": "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.", "example": "gr", "type": "string" }, "grainReferencePrefix": { "description": "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.", "example": "grr", "type": "string" }, "multivalueReferencePrefix": { "description": "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.", "example": "mr", "type": "string" }, "pdm": { "$ref": "#/components/schemas/PdmLdmRequest" }, "primaryLabelPrefix": { "description": "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.", "example": "pl", "type": "string" }, "referencePrefix": { "description": "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.", "example": "r", "type": "string" }, "secondaryLabelPrefix": { "description": "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.", "example": "ls", "type": "string" }, "separator": { "default": "__", "description": "A separator between prefixes and the names. Default is \"__\".", "type": "string" }, "tablePrefix": { "deprecated": true, "description": "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.", "example": "out_table", "type": "string" }, "translationPrefix": { "description": "Columns starting with this prefix will be considered as secondary label translation. The prefix is then followed by the value of `separator` parameter. Given the translation prefix is `tr` and separator is `__`, the columns with name like `tr__attribute__label__en-US` will be considered as secondary label en-US translation to `label` label in `attribute` attribute.", "example": "tr", "type": "string" }, "viewPrefix": { "deprecated": true, "description": "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.", "example": "out_view", "type": "string" }, "wdfPrefix": { "default": "wdf", "description": "Column serving as workspace data filter. No labels are auto generated for such columns.", "type": "string" }, "workspaceId": { "description": "Optional workspace id.", "type": "string" } }, "type": "object" }, "GenerateTitleRequest": { "properties": { "objectId": { "description": "Identifier of the object to title", "type": "string" }, "objectType": { "description": "Type of the object to title. Matches chat-search object types.", "enum": [ "Visualization", "Dashboard", "Metric", "Fact", "Attribute" ], "type": "string" } }, "required": [ "objectId", "objectType" ], "type": "object" }, "GenerateTitleResponse": { "properties": { "note": { "description": "Additional note with details in case generation was not performed", "type": "string" }, "title": { "description": "Generated title of the requested object", "type": "string" } }, "type": "object" }, "GeoAreaConfig": { "description": "Configuration specific to geo area labels.", "properties": { "collection": { "$ref": "#/components/schemas/GeoCollectionIdentifier" } }, "required": [ "collection" ], "type": "object" }, "GeoCollectionIdentifier": { "properties": { "id": { "description": "Geo collection identifier.", "maxLength": 255, "type": "string" }, "kind": { "default": "STATIC", "description": "Type of geo collection.", "enum": [ "STATIC", "CUSTOM" ], "type": "string" } }, "required": [ "id" ], "type": "object" }, "GeoJsonFeature": { "description": "GeoJSON Feature", "properties": { "geometry": { "$ref": "#/components/schemas/GeoJsonGeometry" }, "id": { "type": "object" }, "properties": { "additionalProperties": { "type": "object" }, "type": "object" }, "type": { "type": "string" } }, "required": [ "properties", "type" ], "type": "object" }, "GeoJsonFeatureCollection": { "description": "GeoJSON FeatureCollection", "properties": { "bbox": { "items": { "format": "double", "type": "number" }, "type": "array" }, "features": { "items": { "$ref": "#/components/schemas/GeoJsonFeature" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "features", "type" ], "type": "object" }, "GeoJsonGeometry": { "description": "GeoJSON Geometry", "properties": { "coordinates": { "type": "object" }, "type": { "type": "string" } }, "required": [ "coordinates", "type" ], "type": "object" }, "GetQualityIssuesResponse": { "properties": { "issues": { "description": "List of quality issues found in the workspace", "items": { "$ref": "#/components/schemas/QualityIssue" }, "type": "array" }, "status": { "description": "Status of the latest triggered quality check process", "enum": [ "RUNNING", "SYNCING", "COMPLETED", "FAILED", "CANCELLED", "NOT_FOUND", "DISABLED" ], "type": "string" }, "updatedAt": { "description": "Timestamp when the quality issues were last updated (ISO format)", "type": "string" } }, "required": [ "issues", "status" ], "type": "object" }, "GetServiceStatusResponse": { "description": "Status of an AI Lake service", "properties": { "status": { "$ref": "#/components/schemas/JsonNode" } }, "required": [ "status" ], "type": "object" }, "GrainIdentifier": { "description": "A grain identifier.", "example": { "id": "customer_id", "type": "attribute" }, "maxLength": 255, "properties": { "id": { "description": "Grain ID.", "example": "attr.customers.customer_name", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "A type of the grain.", "enum": [ "attribute", "date" ], "example": "ATTRIBUTE", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "GrantedPermission": { "description": "Permissions granted to the user group", "properties": { "level": { "description": "Level of permission", "example": "VIEW, SHARE, EDIT", "type": "string" }, "source": { "description": "Source of permission", "example": "direct/indirect", "type": "string" } }, "required": [ "level", "source" ], "type": "object" }, "GranularitiesFormatting": { "description": "A date dataset granularities title formatting rules.", "properties": { "titleBase": { "description": "Title base is used as a token in title pattern. If left empty, it is replaced by date dataset title.", "maxLength": 255, "type": "string" }, "titlePattern": { "description": "This pattern is used to generate the title of attributes and labels that result from the granularities.\nThere are two tokens available: \n* `%titleBase` - represents shared part by all titles, or title of Date Dataset if left empty\n* `%granularityTitle` - represents `DateGranularity` built-in title", "example": "%titleBase - %granularityTitle", "maxLength": 255, "type": "string" } }, "required": [ "titleBase", "titlePattern" ], "type": "object" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "title": "Detail", "type": "array" } }, "title": "HTTPValidationError", "type": "object" }, "HashDistributionConfig": { "description": "Hash-based distribution across buckets.", "properties": { "buckets": { "description": "Number of hash buckets. Defaults to 1.", "format": "int32", "minimum": 1, "type": "integer" }, "columns": { "description": "Columns to distribute by. Defaults to first column.", "items": { "description": "Columns to distribute by. Defaults to first column.", "type": "string" }, "type": "array" } }, "type": "object" }, "HeaderGroup": { "description": "Contains the information specific for a group of headers. These groups correlate to attributes and metric groups.", "properties": { "headers": { "description": "An array containing headers.", "items": { "$ref": "#/components/schemas/ExecutionResultHeader" }, "type": "array" } }, "required": [ "headers" ], "type": "object" }, "HierarchyObjectIdentification": { "description": "Represents objects with given ID and type in workspace hierarchy (more than one can exists in different workspaces).", "properties": { "id": { "type": "string" }, "type": { "enum": [ "analyticalDashboard", "attribute", "dashboardPlugin", "dataset", "fact", "label", "metric", "prompt", "visualizationObject", "filterContext", "workspaceDataFilter", "workspaceDataFilterSettings" ], "example": "metric", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "Histogram": { "properties": { "buckets": { "items": { "$ref": "#/components/schemas/HistogramBucket" }, "type": "array" } }, "required": [ "buckets" ], "type": "object" }, "HistogramBucket": { "properties": { "count": { "format": "int64", "type": "integer" }, "lowerBound": { "format": "double", "type": "number" }, "upperBound": { "format": "double", "type": "number" } }, "required": [ "count", "lowerBound", "upperBound" ], "type": "object" }, "HistogramProperties": { "properties": { "bucketCount": { "format": "int32", "type": "integer" } }, "required": [ "bucketCount" ], "type": "object" }, "IdentifierDuplications": { "description": "Contains information about conflicting IDs in workspace hierarchy", "properties": { "id": { "type": "string" }, "origins": { "items": { "type": "string" }, "type": "array" }, "type": { "enum": [ "analyticalDashboard", "attribute", "dashboardPlugin", "dataset", "fact", "label", "metric", "prompt", "visualizationObject", "filterContext", "workspaceDataFilter", "workspaceDataFilterSettings" ], "example": "metric", "type": "string" } }, "required": [ "id", "origins", "type" ], "type": "object" }, "IdentifierRef": { "properties": { "identifier": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "analyticalDashboard", "attribute", "attributeHierarchy", "dashboardPlugin", "dataset", "fact", "aggregatedFact", "label", "metric", "userDataFilter", "parameter", "exportDefinition", "automation", "automationResult", "memoryItem", "knowledgeRecommendation", "prompt", "visualizationObject", "filterContext", "workspaceSettings", "customApplicationSetting", "workspaceDataFilter", "workspaceDataFilterSetting", "filterView" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" } }, "type": "object" }, "ImageExportRequest": { "description": "Export request object describing the export properties and metadata for image exports.", "properties": { "dashboardId": { "description": "Dashboard identifier", "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", "type": "string" }, "fileName": { "description": "File name to be used for retrieving the image document.", "example": "filename", "type": "string" }, "format": { "description": "Requested resulting file type.", "enum": [ "PNG" ], "example": "PNG", "type": "string" }, "metadata": { "$ref": "#/components/schemas/JsonNode" }, "widgetIds": { "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.", "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "maxItems": 1, "minItems": 1, "type": "array", "uniqueItems": true } }, "required": [ "dashboardId", "fileName", "format", "widgetIds" ], "type": "object" }, "ImportCsvRequest": { "description": "Request containing the information necessary to import one or more CSV files from the staging area.", "properties": { "tables": { "description": "Information about the individual tables.", "items": { "$ref": "#/components/schemas/ImportCsvRequestTable" }, "type": "array" } }, "required": [ "tables" ], "type": "object" }, "ImportCsvRequestTable": { "description": "Information about a particular table.", "properties": { "name": { "description": "Name of the table.", "type": "string" }, "source": { "$ref": "#/components/schemas/ImportCsvRequestTableSource" } }, "required": [ "name", "source" ], "type": "object" }, "ImportCsvRequestTableSource": { "description": "Information about source data for a particular table.", "properties": { "config": { "$ref": "#/components/schemas/ImportCsvRequestTableSourceConfig" }, "location": { "description": "Location of the data in the staging area.", "type": "string" } }, "required": [ "config", "location" ], "type": "object" }, "ImportCsvRequestTableSourceConfig": { "description": "Config to use when accessing the data for executions, etc.", "properties": { "columnDateFormats": { "additionalProperties": { "description": "Date formats to use to use to read the given columns.", "type": "string" }, "description": "Date formats to use to use to read the given columns.", "type": "object" }, "convertOptions": { "$ref": "#/components/schemas/CsvConvertOptions" }, "parseOptions": { "$ref": "#/components/schemas/CsvParseOptions" }, "readOptions": { "$ref": "#/components/schemas/CsvReadOptions" } }, "type": "object" }, "ImportCsvResponse": { "description": "Response containing the information about the imported CSV file.", "properties": { "name": { "description": "Name of the table the file was imported to.", "type": "string" }, "version": { "description": "Version the file was imported as.", "format": "int32", "type": "integer" } }, "required": [ "name", "version" ], "type": "object" }, "ImportGeoCollectionRequest": { "description": "Request to import a geo collection file from the staging area.", "properties": { "location": { "description": "Location of the file in the staging area.", "type": "string" } }, "required": [ "location" ], "type": "object" }, "ImportGeoCollectionResponse": { "description": "Response after successfully importing a geo collection.", "properties": { "version": { "description": "The version of the imported geo collection.", "format": "int32", "type": "integer" } }, "required": [ "version" ], "type": "object" }, "InPlatform": { "allOf": [ { "properties": { "type": { "description": "The destination type.", "enum": [ "IN_PLATFORM" ], "type": "string" } }, "type": "object" } ], "description": "In-platform destination for notifications.", "properties": { "type": { "description": "The destination type.", "enum": [ "IN_PLATFORM" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "InlineFilterDefinition": { "additionalProperties": false, "description": "Filter in form of direct MAQL query.", "properties": { "inline": { "$ref": "#/components/schemas/InlineFilterDefinitionBody", "properties": { "applyOnResult": { "type": "boolean" }, "filter": { "description": "MAQL query representing the filter.", "type": "string" }, "localIdentifier": { "type": "string" } }, "required": [ "filter" ], "type": "object" } }, "required": [ "inline" ], "title": "InlineFilterDefinition", "type": "object" }, "InlineFilterDefinitionBody": { "additionalProperties": false, "properties": { "applyOnResult": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Applyonresult" }, "filter": { "title": "Filter", "type": "string" }, "localIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Localidentifier" } }, "required": [ "filter" ], "title": "InlineFilterDefinitionBody", "type": "object" }, "InlineMeasureDefinition": { "description": "Metric defined by the raw MAQL query.", "properties": { "inline": { "properties": { "maql": { "description": "MAQL query defining the metric.", "type": "string" } }, "required": [ "maql" ], "type": "object" } }, "required": [ "inline" ], "type": "object" }, "InsightWidgetDescriptor": { "description": "Insight widget displaying a visualization.", "properties": { "filters": { "description": "Filters currently applied to the dashboard.", "items": { "$ref": "#/components/schemas/FilterDefinition" }, "type": "array" }, "resultId": { "description": "Signed result ID for this widget's cached execution result.", "type": "string" }, "title": { "description": "Widget title as displayed on the dashboard.", "type": "string" }, "visualizationId": { "description": "Visualization object ID referenced by this insight widget.", "type": "string" }, "widgetId": { "description": "Widget object ID.", "type": "string" } }, "required": [ "title", "visualizationId", "widgetId" ], "type": "object" }, "IntervalGranularity": { "description": "Date granularity for the interval of an ONCE_PER_INTERVAL trigger.", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ], "title": "IntervalGranularity", "type": "string" }, "IntroSlideTemplate": { "description": "Settings for intro slide.", "nullable": true, "properties": { "backgroundImage": { "default": true, "description": "Show background image on the slide.", "type": "boolean" }, "descriptionField": { "example": "About:\n{{dashboardDescription}}\n\n{{dashboardFilters}}", "nullable": true, "type": "string" }, "footer": { "$ref": "#/components/schemas/RunningSection" }, "header": { "$ref": "#/components/schemas/RunningSection" }, "titleField": { "example": "Introduction", "nullable": true, "type": "string" } }, "type": "object" }, "Invitation": { "properties": { "email": { "format": "email", "type": "string" }, "firstName": { "type": "string" }, "forceSend": { "description": "Force resend invitation email even if a pending invitation exists. Maximum 3 emails can be sent per invitation (1 initial + 2 resends)", "type": "boolean" }, "lastName": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "email", "userId" ], "type": "object" }, "IpAllowlistPolicyTargets": { "description": "Target delta for IP allowlist policy actions.", "properties": { "targets": { "items": { "$ref": "#/components/schemas/AssigneeIdentifier" }, "type": "array" } }, "required": [ "targets" ], "type": "object" }, "JsonApiAgentIn": { "description": "JSON:API representation of agent entity.", "properties": { "attributes": { "properties": { "aiKnowledge": { "type": "boolean" }, "availableToAll": { "type": "boolean" }, "customSkills": { "items": { "enum": [ "alert", "anomaly_detection", "clustering", "forecasting", "key_driver_analysis", "metric", "schedule_export", "visualization", "visualization_summary", "dashboard_summary", "what_if_analysis", "knowledge" ], "type": "string" }, "nullable": true, "type": "array" }, "description": { "maxLength": 10000, "nullable": true, "type": "string" }, "enabled": { "type": "boolean" }, "isPreview": { "type": "boolean" }, "name": { "maxLength": 255, "nullable": true, "type": "string" }, "personality": { "maxLength": 10000, "nullable": true, "type": "string" }, "skillsMode": { "enum": [ "all", "custom" ], "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "userGroups": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "agent" ], "example": "agent", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiAgentInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAgentIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiAgentOut": { "description": "JSON:API representation of agent entity.", "properties": { "attributes": { "properties": { "aiKnowledge": { "type": "boolean" }, "availableToAll": { "type": "boolean" }, "createdAt": { "format": "date-time", "type": "string" }, "customSkills": { "items": { "enum": [ "alert", "anomaly_detection", "clustering", "forecasting", "key_driver_analysis", "metric", "schedule_export", "visualization", "visualization_summary", "dashboard_summary", "what_if_analysis", "knowledge" ], "type": "string" }, "nullable": true, "type": "array" }, "description": { "maxLength": 10000, "nullable": true, "type": "string" }, "enabled": { "type": "boolean" }, "isPreview": { "type": "boolean" }, "modifiedAt": { "format": "date-time", "type": "string" }, "name": { "maxLength": 255, "nullable": true, "type": "string" }, "personality": { "maxLength": 10000, "nullable": true, "type": "string" }, "skillsMode": { "enum": [ "all", "custom" ], "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "createdBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "modifiedBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "userGroups": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "agent" ], "example": "agent", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiAgentOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAgentOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiAgentOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiAgentOutIncludes": { "oneOf": [ { "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" } ] }, "JsonApiAgentOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiAgentOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiAgentOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiAgentOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiAgentOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiAgentPatch": { "description": "JSON:API representation of patching agent entity.", "properties": { "attributes": { "properties": { "aiKnowledge": { "type": "boolean" }, "availableToAll": { "type": "boolean" }, "customSkills": { "items": { "enum": [ "alert", "anomaly_detection", "clustering", "forecasting", "key_driver_analysis", "metric", "schedule_export", "visualization", "visualization_summary", "dashboard_summary", "what_if_analysis", "knowledge" ], "type": "string" }, "nullable": true, "type": "array" }, "description": { "maxLength": 10000, "nullable": true, "type": "string" }, "enabled": { "type": "boolean" }, "isPreview": { "type": "boolean" }, "name": { "maxLength": 255, "nullable": true, "type": "string" }, "personality": { "maxLength": 10000, "nullable": true, "type": "string" }, "skillsMode": { "enum": [ "all", "custom" ], "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "userGroups": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "agent" ], "example": "agent", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiAgentPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAgentPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiAggregatedFactLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { "type": "string" }, "type": { "enum": [ "aggregatedFact" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiAggregatedFactOut": { "description": "JSON:API representation of aggregatedFact entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "description": { "maxLength": 10000, "type": "string" }, "isNullable": { "type": "boolean" }, "nullValue": { "type": "string" }, "operation": { "enum": [ "SUM", "MIN", "MAX", "APPROXIMATE_COUNT" ], "type": "string" }, "sourceColumn": { "maxLength": 255, "type": "string" }, "sourceColumnDataType": { "enum": [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN", "HLL" ], "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "required": [ "operation" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "meta": { "properties": { "origin": { "properties": { "originId": { "description": "defines id of the workspace where the entity comes from", "type": "string" }, "originType": { "description": "defines type of the origin of the entity", "enum": [ "NATIVE", "PARENT" ], "type": "string" } }, "required": [ "originId", "originType" ], "type": "object" } }, "type": "object" }, "relationships": { "properties": { "dataset": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiDatasetToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "sourceAttribute": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAttributeToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "sourceFact": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiFactToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "aggregatedFact" ], "example": "aggregatedFact", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiAggregatedFactOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAggregatedFactOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiAggregatedFactOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiAggregatedFactOutIncludes": { "oneOf": [ { "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiFactOutWithLinks" } ] }, "JsonApiAggregatedFactOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiAggregatedFactOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiAggregatedFactOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiAggregatedFactOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiAggregatedFactOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiAggregatedFactToManyLinkage": { "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "items": { "$ref": "#/components/schemas/JsonApiAggregatedFactLinkage" }, "type": "array" }, "JsonApiAnalyticalDashboardIn": { "description": "JSON:API representation of analyticalDashboard entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "content": { "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": { "identifier": { "id": "label.leaf", "type": "label" }, "someBoolProp": false }, "type": "object" }, "description": { "maxLength": 10000, "type": "string" }, "summary": { "description": "AI-generated summary of the dashboard content", "maxLength": 10000, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "required": [ "content" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "analyticalDashboard" ], "example": "analyticalDashboard", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiAnalyticalDashboardInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiAnalyticalDashboardLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { "type": "string" }, "type": { "enum": [ "analyticalDashboard" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiAnalyticalDashboardOut": { "description": "JSON:API representation of analyticalDashboard entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "certification": { "description": "Certification status of the entity.", "enum": [ "CERTIFIED" ], "type": "string" }, "certificationMessage": { "description": "Optional message associated with the certification.", "nullable": true, "type": "string" }, "certifiedAt": { "description": "Time when the certification was set.", "example": "2023-07-20 12:30", "format": "date-time", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "content": { "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": { "identifier": { "id": "label.leaf", "type": "label" }, "someBoolProp": false }, "type": "object" }, "createdAt": { "description": "Time of the entity creation.", "example": "2023-07-20 12:30", "format": "date-time", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "description": { "maxLength": 10000, "type": "string" }, "modifiedAt": { "description": "Time of the last entity modification.", "example": "2023-07-20 12:30", "format": "date-time", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "summary": { "description": "AI-generated summary of the dashboard content", "maxLength": 10000, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "required": [ "content" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "meta": { "properties": { "accessInfo": { "properties": { "private": { "description": "is the entity private to the currently logged-in user", "type": "boolean" } }, "required": [ "private" ], "type": "object" }, "origin": { "properties": { "originId": { "description": "defines id of the workspace where the entity comes from", "type": "string" }, "originType": { "description": "defines type of the origin of the entity", "enum": [ "NATIVE", "PARENT" ], "type": "string" } }, "required": [ "originId", "originType" ], "type": "object" }, "permissions": { "description": "List of valid permissions for a logged-in user.", "items": { "enum": [ "EDIT", "SHARE", "VIEW" ], "type": "string" }, "type": "array" } }, "type": "object" }, "relationships": { "properties": { "analyticalDashboards": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "certifiedBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "createdBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "dashboardPlugins": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiDashboardPluginToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "datasets": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "filterContexts": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiFilterContextToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "labels": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "metrics": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiMetricToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "modifiedBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "parameters": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiParameterToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "visualizationObjects": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiVisualizationObjectToManyLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "analyticalDashboard" ], "example": "analyticalDashboard", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiAnalyticalDashboardOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiAnalyticalDashboardOutIncludes": { "oneOf": [ { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiDashboardPluginOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiFilterContextOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiParameterOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiVisualizationObjectOutWithLinks" } ] }, "JsonApiAnalyticalDashboardOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiAnalyticalDashboardOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiAnalyticalDashboardPatch": { "description": "JSON:API representation of patching analyticalDashboard entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "content": { "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": { "identifier": { "id": "label.leaf", "type": "label" }, "someBoolProp": false }, "type": "object" }, "description": { "maxLength": 10000, "type": "string" }, "summary": { "description": "AI-generated summary of the dashboard content", "maxLength": 10000, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "analyticalDashboard" ], "example": "analyticalDashboard", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiAnalyticalDashboardPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiAnalyticalDashboardPostOptionalId": { "description": "JSON:API representation of analyticalDashboard entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "content": { "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": { "identifier": { "id": "label.leaf", "type": "label" }, "someBoolProp": false }, "type": "object" }, "description": { "maxLength": 10000, "type": "string" }, "summary": { "description": "AI-generated summary of the dashboard content", "maxLength": 10000, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "required": [ "content" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "analyticalDashboard" ], "example": "analyticalDashboard", "type": "string" } }, "required": [ "attributes", "type" ], "type": "object" }, "JsonApiAnalyticalDashboardPostOptionalIdDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPostOptionalId" } }, "required": [ "data" ], "type": "object" }, "JsonApiAnalyticalDashboardToManyLinkage": { "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "items": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardLinkage" }, "type": "array" }, "JsonApiAnalyticalDashboardToOneLinkage": { "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardLinkage" } ] }, "JsonApiApiTokenIn": { "description": "JSON:API representation of apiToken entity.", "properties": { "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "apiToken" ], "example": "apiToken", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiApiTokenInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiApiTokenIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiApiTokenOut": { "description": "JSON:API representation of apiToken entity.", "properties": { "attributes": { "properties": { "bearerToken": { "description": "The value of the Bearer token. It is only returned when the API token is created.", "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "apiToken" ], "example": "apiToken", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiApiTokenOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiApiTokenOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiApiTokenOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiApiTokenOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiApiTokenOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiApiTokenOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiAttributeHierarchyIn": { "description": "JSON:API representation of attributeHierarchy entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "content": { "description": "Free-form JSON content. Maximum supported length is 15000 characters.", "example": { "attributes": [ { "identifier": { "id": "country", "type": "attribute" } }, { "identifier": { "id": "city", "type": "attribute" } } ] }, "type": "object" }, "description": { "maxLength": 10000, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "attributeHierarchy" ], "example": "attributeHierarchy", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiAttributeHierarchyInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiAttributeHierarchyLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { "type": "string" }, "type": { "enum": [ "attributeHierarchy" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiAttributeHierarchyOut": { "description": "JSON:API representation of attributeHierarchy entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "content": { "description": "Free-form JSON content. Maximum supported length is 15000 characters.", "example": { "attributes": [ { "identifier": { "id": "country", "type": "attribute" } }, { "identifier": { "id": "city", "type": "attribute" } } ] }, "type": "object" }, "createdAt": { "description": "Time of the entity creation.", "example": "2023-07-20 12:30", "format": "date-time", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "description": { "maxLength": 10000, "type": "string" }, "modifiedAt": { "description": "Time of the last entity modification.", "example": "2023-07-20 12:30", "format": "date-time", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "meta": { "properties": { "origin": { "properties": { "originId": { "description": "defines id of the workspace where the entity comes from", "type": "string" }, "originType": { "description": "defines type of the origin of the entity", "enum": [ "NATIVE", "PARENT" ], "type": "string" } }, "required": [ "originId", "originType" ], "type": "object" } }, "type": "object" }, "relationships": { "properties": { "attributes": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "createdBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "modifiedBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "attributeHierarchy" ], "example": "attributeHierarchy", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiAttributeHierarchyOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiAttributeHierarchyOutIncludes": { "oneOf": [ { "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" } ] }, "JsonApiAttributeHierarchyOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiAttributeHierarchyOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiAttributeHierarchyOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiAttributeHierarchyPatch": { "description": "JSON:API representation of patching attributeHierarchy entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "content": { "description": "Free-form JSON content. Maximum supported length is 15000 characters.", "example": { "attributes": [ { "identifier": { "id": "country", "type": "attribute" } }, { "identifier": { "id": "city", "type": "attribute" } } ] }, "type": "object" }, "description": { "maxLength": 10000, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "attributeHierarchy" ], "example": "attributeHierarchy", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiAttributeHierarchyPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiAttributeHierarchyToManyLinkage": { "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "items": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyLinkage" }, "type": "array" }, "JsonApiAttributeLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { "type": "string" }, "type": { "enum": [ "attribute" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiAttributeOut": { "description": "JSON:API representation of attribute entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "description": { "maxLength": 10000, "type": "string" }, "granularity": { "enum": [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR" ], "type": "string" }, "isHidden": { "type": "boolean" }, "isNullable": { "type": "boolean" }, "locale": { "type": "string" }, "nullValue": { "type": "string" }, "sortColumn": { "maxLength": 255, "type": "string" }, "sortDirection": { "enum": [ "ASC", "DESC" ], "type": "string" }, "sourceColumn": { "maxLength": 255, "type": "string" }, "sourceColumnDataType": { "enum": [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN", "HLL" ], "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "meta": { "properties": { "origin": { "properties": { "originId": { "description": "defines id of the workspace where the entity comes from", "type": "string" }, "originType": { "description": "defines type of the origin of the entity", "enum": [ "NATIVE", "PARENT" ], "type": "string" } }, "required": [ "originId", "originType" ], "type": "object" } }, "type": "object" }, "relationships": { "properties": { "attributeHierarchies": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "dataset": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiDatasetToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "defaultView": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiLabelToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "labels": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "attribute" ], "example": "attribute", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiAttributeOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAttributeOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiAttributeOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiAttributeOutIncludes": { "oneOf": [ { "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" } ] }, "JsonApiAttributeOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiAttributeOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiAttributeOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiAttributeOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiAttributePatch": { "description": "JSON:API representation of patching attribute entity.", "properties": { "attributes": { "properties": { "description": { "maxLength": 10000, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "defaultView": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiLabelToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "attribute" ], "example": "attribute", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiAttributePatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAttributePatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiAttributeToManyLinkage": { "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "items": { "$ref": "#/components/schemas/JsonApiAttributeLinkage" }, "type": "array" }, "JsonApiAttributeToOneLinkage": { "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonApiAttributeLinkage" } ] }, "JsonApiAutomationIn": { "description": "JSON:API representation of automation entity.", "properties": { "attributes": { "properties": { "alert": { "properties": { "condition": { "$ref": "#/components/schemas/AlertCondition" }, "execution": { "$ref": "#/components/schemas/AlertAfm" }, "interval": { "description": "Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ], "type": "string" }, "trigger": { "default": "ALWAYS", "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\nONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS.\n", "enum": [ "ALWAYS", "ONCE", "ONCE_PER_INTERVAL" ], "type": "string" } }, "required": [ "condition", "execution" ], "type": "object" }, "areRelationsValid": { "type": "boolean" }, "dashboardTabularExports": { "items": { "properties": { "requestPayload": { "$ref": "#/components/schemas/DashboardTabularExportRequestV2" } }, "required": [ "requestPayload" ], "type": "object" }, "type": "array" }, "description": { "maxLength": 10000, "type": "string" }, "details": { "description": "Additional details to be included in the automated message.", "maxLength": 10000, "type": "object" }, "evaluationMode": { "description": "Specify automation evaluation mode.", "enum": [ "SHARED", "PER_RECIPIENT" ], "type": "string" }, "externalRecipients": { "description": "External recipients of the automation action results.", "items": { "properties": { "email": { "description": "E-mail address to send notifications from.", "format": "email", "type": "string" } }, "required": [ "email" ], "type": "object" }, "type": "array" }, "imageExports": { "items": { "properties": { "requestPayload": { "$ref": "#/components/schemas/ImageExportRequest" } }, "required": [ "requestPayload" ], "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": true, "description": "Additional information for the automation.", "maxLength": 250000, "nullable": true, "properties": { "visibleFilters": { "items": { "$ref": "#/components/schemas/VisibleFilter" }, "type": "array" }, "widget": { "type": "string" } }, "type": "object" }, "rawExports": { "items": { "properties": { "requestPayload": { "$ref": "#/components/schemas/RawExportAutomationRequest" } }, "required": [ "requestPayload" ], "type": "object" }, "type": "array" }, "schedule": { "properties": { "cron": { "description": "Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.", "example": "0 */30 9-17 ? * MON-FRI", "maxLength": 255, "type": "string" }, "cronDescription": { "description": "Human-readable description of the cron expression.", "readOnly": true, "type": "string" }, "firstRun": { "description": "Timestamp of the first scheduled action. If not provided default to the next scheduled time.", "example": "2025-01-01T12:00:00Z", "format": "date-time", "type": "string" }, "timezone": { "description": "Timezone in which the schedule is defined.", "example": "Europe/Prague", "maxLength": 255, "type": "string" } }, "required": [ "cron", "timezone" ], "type": "object" }, "slidesExports": { "items": { "properties": { "requestPayload": { "$ref": "#/components/schemas/SlidesExportRequest" } }, "required": [ "requestPayload" ], "type": "object" }, "type": "array" }, "state": { "description": "Current state of the automation.", "enum": [ "ACTIVE", "PAUSED" ], "type": "string" }, "tabularExports": { "items": { "properties": { "requestPayload": { "$ref": "#/components/schemas/TabularExportRequest" } }, "required": [ "requestPayload" ], "type": "object" }, "type": "array" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" }, "visualExports": { "items": { "properties": { "requestPayload": { "$ref": "#/components/schemas/VisualExportRequest" } }, "required": [ "requestPayload" ], "type": "object" }, "type": "array" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "analyticalDashboard": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "exportDefinitions": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiExportDefinitionToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "notificationChannel": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiNotificationChannelToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "recipients": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserToManyLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "automation" ], "example": "automation", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiAutomationInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAutomationIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiAutomationLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { "type": "string" }, "type": { "enum": [ "automation" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiAutomationOut": { "description": "JSON:API representation of automation entity.", "properties": { "attributes": { "properties": { "alert": { "properties": { "condition": { "$ref": "#/components/schemas/AlertCondition" }, "execution": { "$ref": "#/components/schemas/AlertAfm" }, "interval": { "description": "Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ], "type": "string" }, "trigger": { "default": "ALWAYS", "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\nONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS.\n", "enum": [ "ALWAYS", "ONCE", "ONCE_PER_INTERVAL" ], "type": "string" } }, "required": [ "condition", "execution" ], "type": "object" }, "areRelationsValid": { "type": "boolean" }, "createdAt": { "description": "Time of the entity creation.", "example": "2023-07-20 12:30", "format": "date-time", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "dashboardTabularExports": { "items": { "properties": { "requestPayload": { "$ref": "#/components/schemas/DashboardTabularExportRequestV2" } }, "required": [ "requestPayload" ], "type": "object" }, "type": "array" }, "description": { "maxLength": 10000, "type": "string" }, "details": { "description": "Additional details to be included in the automated message.", "maxLength": 10000, "type": "object" }, "evaluationMode": { "description": "Specify automation evaluation mode.", "enum": [ "SHARED", "PER_RECIPIENT" ], "type": "string" }, "externalRecipients": { "description": "External recipients of the automation action results.", "items": { "properties": { "email": { "description": "E-mail address to send notifications from.", "format": "email", "type": "string" } }, "required": [ "email" ], "type": "object" }, "type": "array" }, "imageExports": { "items": { "properties": { "requestPayload": { "$ref": "#/components/schemas/ImageExportRequest" } }, "required": [ "requestPayload" ], "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": true, "description": "Additional information for the automation.", "maxLength": 250000, "nullable": true, "properties": { "visibleFilters": { "items": { "$ref": "#/components/schemas/VisibleFilter" }, "type": "array" }, "widget": { "type": "string" } }, "type": "object" }, "modifiedAt": { "description": "Time of the last entity modification.", "example": "2023-07-20 12:30", "format": "date-time", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "rawExports": { "items": { "properties": { "requestPayload": { "$ref": "#/components/schemas/RawExportAutomationRequest" } }, "required": [ "requestPayload" ], "type": "object" }, "type": "array" }, "schedule": { "properties": { "cron": { "description": "Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.", "example": "0 */30 9-17 ? * MON-FRI", "maxLength": 255, "type": "string" }, "cronDescription": { "description": "Human-readable description of the cron expression.", "readOnly": true, "type": "string" }, "firstRun": { "description": "Timestamp of the first scheduled action. If not provided default to the next scheduled time.", "example": "2025-01-01T12:00:00Z", "format": "date-time", "type": "string" }, "timezone": { "description": "Timezone in which the schedule is defined.", "example": "Europe/Prague", "maxLength": 255, "type": "string" } }, "required": [ "cron", "timezone" ], "type": "object" }, "slidesExports": { "items": { "properties": { "requestPayload": { "$ref": "#/components/schemas/SlidesExportRequest" } }, "required": [ "requestPayload" ], "type": "object" }, "type": "array" }, "state": { "description": "Current state of the automation.", "enum": [ "ACTIVE", "PAUSED" ], "type": "string" }, "tabularExports": { "items": { "properties": { "requestPayload": { "$ref": "#/components/schemas/TabularExportRequest" } }, "required": [ "requestPayload" ], "type": "object" }, "type": "array" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" }, "visualExports": { "items": { "properties": { "requestPayload": { "$ref": "#/components/schemas/VisualExportRequest" } }, "required": [ "requestPayload" ], "type": "object" }, "type": "array" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "meta": { "properties": { "origin": { "properties": { "originId": { "description": "defines id of the workspace where the entity comes from", "type": "string" }, "originType": { "description": "defines type of the origin of the entity", "enum": [ "NATIVE", "PARENT" ], "type": "string" } }, "required": [ "originId", "originType" ], "type": "object" } }, "type": "object" }, "relationships": { "properties": { "analyticalDashboard": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "automationResults": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAutomationResultToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "createdBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "exportDefinitions": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiExportDefinitionToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "modifiedBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "notificationChannel": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiNotificationChannelToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "recipients": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserToManyLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "automation" ], "example": "automation", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiAutomationOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAutomationOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiAutomationOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiAutomationOutIncludes": { "oneOf": [ { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiAutomationResultOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiExportDefinitionOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiNotificationChannelOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiUserOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" } ] }, "JsonApiAutomationOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiAutomationOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiAutomationOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiAutomationOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiAutomationOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiAutomationPatch": { "description": "JSON:API representation of patching automation entity.", "properties": { "attributes": { "properties": { "alert": { "properties": { "condition": { "$ref": "#/components/schemas/AlertCondition" }, "execution": { "$ref": "#/components/schemas/AlertAfm" }, "interval": { "description": "Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ], "type": "string" }, "trigger": { "default": "ALWAYS", "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\nONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS.\n", "enum": [ "ALWAYS", "ONCE", "ONCE_PER_INTERVAL" ], "type": "string" } }, "required": [ "condition", "execution" ], "type": "object" }, "areRelationsValid": { "type": "boolean" }, "dashboardTabularExports": { "items": { "properties": { "requestPayload": { "$ref": "#/components/schemas/DashboardTabularExportRequestV2" } }, "required": [ "requestPayload" ], "type": "object" }, "type": "array" }, "description": { "maxLength": 10000, "type": "string" }, "details": { "description": "Additional details to be included in the automated message.", "maxLength": 10000, "type": "object" }, "evaluationMode": { "description": "Specify automation evaluation mode.", "enum": [ "SHARED", "PER_RECIPIENT" ], "type": "string" }, "externalRecipients": { "description": "External recipients of the automation action results.", "items": { "properties": { "email": { "description": "E-mail address to send notifications from.", "format": "email", "type": "string" } }, "required": [ "email" ], "type": "object" }, "type": "array" }, "imageExports": { "items": { "properties": { "requestPayload": { "$ref": "#/components/schemas/ImageExportRequest" } }, "required": [ "requestPayload" ], "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": true, "description": "Additional information for the automation.", "maxLength": 250000, "nullable": true, "properties": { "visibleFilters": { "items": { "$ref": "#/components/schemas/VisibleFilter" }, "type": "array" }, "widget": { "type": "string" } }, "type": "object" }, "rawExports": { "items": { "properties": { "requestPayload": { "$ref": "#/components/schemas/RawExportAutomationRequest" } }, "required": [ "requestPayload" ], "type": "object" }, "type": "array" }, "schedule": { "properties": { "cron": { "description": "Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.", "example": "0 */30 9-17 ? * MON-FRI", "maxLength": 255, "type": "string" }, "cronDescription": { "description": "Human-readable description of the cron expression.", "readOnly": true, "type": "string" }, "firstRun": { "description": "Timestamp of the first scheduled action. If not provided default to the next scheduled time.", "example": "2025-01-01T12:00:00Z", "format": "date-time", "type": "string" }, "timezone": { "description": "Timezone in which the schedule is defined.", "example": "Europe/Prague", "maxLength": 255, "type": "string" } }, "required": [ "cron", "timezone" ], "type": "object" }, "slidesExports": { "items": { "properties": { "requestPayload": { "$ref": "#/components/schemas/SlidesExportRequest" } }, "required": [ "requestPayload" ], "type": "object" }, "type": "array" }, "state": { "description": "Current state of the automation.", "enum": [ "ACTIVE", "PAUSED" ], "type": "string" }, "tabularExports": { "items": { "properties": { "requestPayload": { "$ref": "#/components/schemas/TabularExportRequest" } }, "required": [ "requestPayload" ], "type": "object" }, "type": "array" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" }, "visualExports": { "items": { "properties": { "requestPayload": { "$ref": "#/components/schemas/VisualExportRequest" } }, "required": [ "requestPayload" ], "type": "object" }, "type": "array" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "analyticalDashboard": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "exportDefinitions": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiExportDefinitionToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "notificationChannel": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiNotificationChannelToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "recipients": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserToManyLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "automation" ], "example": "automation", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiAutomationPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAutomationPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiAutomationResultLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { "type": "string" }, "type": { "enum": [ "automationResult" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiAutomationResultOut": { "description": "JSON:API representation of automationResult entity.", "properties": { "attributes": { "properties": { "errorMessage": { "maxLength": 10000, "type": "string" }, "executedAt": { "description": "Timestamp of the last automation run.", "format": "date-time", "type": "string" }, "status": { "description": "Status of the last automation run.", "enum": [ "SUCCESS", "FAILED" ], "type": "string" }, "traceId": { "maxLength": 255, "type": "string" } }, "required": [ "executedAt", "status" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "automation": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAutomationToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "automationResult" ], "example": "automationResult", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiAutomationResultOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiAutomationResultOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiAutomationOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiAutomationResultOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiAutomationResultOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiAutomationResultToManyLinkage": { "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "items": { "$ref": "#/components/schemas/JsonApiAutomationResultLinkage" }, "type": "array" }, "JsonApiAutomationToOneLinkage": { "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonApiAutomationLinkage" } ] }, "JsonApiColorPaletteIn": { "description": "JSON:API representation of colorPalette entity.", "properties": { "attributes": { "properties": { "content": { "description": "Free-form JSON content. Maximum supported length is 15000 characters.", "example": {}, "type": "object" }, "name": { "maxLength": 255, "type": "string" } }, "required": [ "content", "name" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "colorPalette" ], "example": "colorPalette", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiColorPaletteInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiColorPaletteIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiColorPaletteOut": { "description": "JSON:API representation of colorPalette entity.", "properties": { "attributes": { "properties": { "content": { "description": "Free-form JSON content. Maximum supported length is 15000 characters.", "example": {}, "type": "object" }, "name": { "maxLength": 255, "type": "string" } }, "required": [ "content", "name" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "colorPalette" ], "example": "colorPalette", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiColorPaletteOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiColorPaletteOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiColorPaletteOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiColorPaletteOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiColorPaletteOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiColorPaletteOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiColorPalettePatch": { "description": "JSON:API representation of patching colorPalette entity.", "properties": { "attributes": { "properties": { "content": { "description": "Free-form JSON content. Maximum supported length is 15000 characters.", "example": {}, "type": "object" }, "name": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "colorPalette" ], "example": "colorPalette", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiColorPalettePatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiColorPalettePatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiCookieSecurityConfigurationIn": { "description": "JSON:API representation of cookieSecurityConfiguration entity.", "properties": { "attributes": { "properties": { "lastRotation": { "format": "date-time", "type": "string" }, "rotationInterval": { "description": "Length of interval between automatic rotations expressed in format of ISO 8601 duration", "example": "P30D", "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "cookieSecurityConfiguration" ], "example": "cookieSecurityConfiguration", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiCookieSecurityConfigurationInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiCookieSecurityConfigurationOut": { "description": "JSON:API representation of cookieSecurityConfiguration entity.", "properties": { "attributes": { "properties": { "lastRotation": { "format": "date-time", "type": "string" }, "rotationInterval": { "description": "Length of interval between automatic rotations expressed in format of ISO 8601 duration", "example": "P30D", "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "cookieSecurityConfiguration" ], "example": "cookieSecurityConfiguration", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiCookieSecurityConfigurationOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiCookieSecurityConfigurationPatch": { "description": "JSON:API representation of patching cookieSecurityConfiguration entity.", "properties": { "attributes": { "properties": { "lastRotation": { "format": "date-time", "type": "string" }, "rotationInterval": { "description": "Length of interval between automatic rotations expressed in format of ISO 8601 duration", "example": "P30D", "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "cookieSecurityConfiguration" ], "example": "cookieSecurityConfiguration", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiCookieSecurityConfigurationPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiCspDirectiveIn": { "description": "JSON:API representation of cspDirective entity.", "properties": { "attributes": { "properties": { "sources": { "items": { "type": "string" }, "type": "array" } }, "required": [ "sources" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "cspDirective" ], "example": "cspDirective", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiCspDirectiveInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiCspDirectiveIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiCspDirectiveOut": { "description": "JSON:API representation of cspDirective entity.", "properties": { "attributes": { "properties": { "sources": { "items": { "type": "string" }, "type": "array" } }, "required": [ "sources" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "cspDirective" ], "example": "cspDirective", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiCspDirectiveOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiCspDirectiveOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiCspDirectiveOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiCspDirectiveOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiCspDirectiveOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiCspDirectiveOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiCspDirectivePatch": { "description": "JSON:API representation of patching cspDirective entity.", "properties": { "attributes": { "properties": { "sources": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "cspDirective" ], "example": "cspDirective", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiCspDirectivePatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiCspDirectivePatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiCustomApplicationSettingIn": { "description": "JSON:API representation of customApplicationSetting entity.", "properties": { "attributes": { "properties": { "applicationName": { "maxLength": 255, "type": "string" }, "content": { "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": {}, "type": "object" } }, "required": [ "applicationName", "content" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "customApplicationSetting" ], "example": "customApplicationSetting", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiCustomApplicationSettingInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiCustomApplicationSettingIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiCustomApplicationSettingOut": { "description": "JSON:API representation of customApplicationSetting entity.", "properties": { "attributes": { "properties": { "applicationName": { "maxLength": 255, "type": "string" }, "content": { "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": {}, "type": "object" } }, "required": [ "applicationName", "content" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "meta": { "properties": { "origin": { "properties": { "originId": { "description": "defines id of the workspace where the entity comes from", "type": "string" }, "originType": { "description": "defines type of the origin of the entity", "enum": [ "NATIVE", "PARENT" ], "type": "string" } }, "required": [ "originId", "originType" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "customApplicationSetting" ], "example": "customApplicationSetting", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiCustomApplicationSettingOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiCustomApplicationSettingOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiCustomApplicationSettingOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiCustomApplicationSettingPatch": { "description": "JSON:API representation of patching customApplicationSetting entity.", "properties": { "attributes": { "properties": { "applicationName": { "maxLength": 255, "type": "string" }, "content": { "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": {}, "type": "object" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "customApplicationSetting" ], "example": "customApplicationSetting", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiCustomApplicationSettingPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiCustomApplicationSettingPostOptionalId": { "description": "JSON:API representation of customApplicationSetting entity.", "properties": { "attributes": { "properties": { "applicationName": { "maxLength": 255, "type": "string" }, "content": { "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": {}, "type": "object" } }, "required": [ "applicationName", "content" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "customApplicationSetting" ], "example": "customApplicationSetting", "type": "string" } }, "required": [ "attributes", "type" ], "type": "object" }, "JsonApiCustomApplicationSettingPostOptionalIdDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPostOptionalId" } }, "required": [ "data" ], "type": "object" }, "JsonApiCustomGeoCollectionIn": { "description": "JSON:API representation of customGeoCollection entity.", "properties": { "attributes": { "properties": { "description": { "maxLength": 10000, "nullable": true, "type": "string" }, "name": { "maxLength": 255, "nullable": true, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "customGeoCollection" ], "example": "customGeoCollection", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiCustomGeoCollectionInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiCustomGeoCollectionIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiCustomGeoCollectionOut": { "description": "JSON:API representation of customGeoCollection entity.", "properties": { "attributes": { "properties": { "description": { "maxLength": 10000, "nullable": true, "type": "string" }, "name": { "maxLength": 255, "nullable": true, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "customGeoCollection" ], "example": "customGeoCollection", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiCustomGeoCollectionOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiCustomGeoCollectionOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiCustomGeoCollectionOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiCustomGeoCollectionPatch": { "description": "JSON:API representation of patching customGeoCollection entity.", "properties": { "attributes": { "properties": { "description": { "maxLength": 10000, "nullable": true, "type": "string" }, "name": { "maxLength": 255, "nullable": true, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "customGeoCollection" ], "example": "customGeoCollection", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiCustomGeoCollectionPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiCustomGeoCollectionPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiCustomUserApplicationSettingIn": { "description": "JSON:API representation of customUserApplicationSetting entity.", "properties": { "attributes": { "properties": { "applicationName": { "maxLength": 255, "type": "string" }, "content": { "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": {}, "type": "object" }, "workspaceId": { "description": "Workspace scope for this setting. Must reference an existing workspace the caller has at least VIEW access to. Null means user-level (no workspace scope).", "maxLength": 255, "nullable": true, "type": "string" } }, "required": [ "applicationName", "content" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "customUserApplicationSetting" ], "example": "customUserApplicationSetting", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiCustomUserApplicationSettingInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiCustomUserApplicationSettingOut": { "description": "JSON:API representation of customUserApplicationSetting entity.", "properties": { "attributes": { "properties": { "applicationName": { "maxLength": 255, "type": "string" }, "content": { "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": {}, "type": "object" }, "workspaceId": { "description": "Workspace scope for this setting. Must reference an existing workspace the caller has at least VIEW access to. Null means user-level (no workspace scope).", "maxLength": 255, "nullable": true, "type": "string" } }, "required": [ "applicationName", "content" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "customUserApplicationSetting" ], "example": "customUserApplicationSetting", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiCustomUserApplicationSettingOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiCustomUserApplicationSettingOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiCustomUserApplicationSettingOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiCustomUserApplicationSettingPostOptionalId": { "description": "JSON:API representation of customUserApplicationSetting entity.", "properties": { "attributes": { "properties": { "applicationName": { "maxLength": 255, "type": "string" }, "content": { "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": {}, "type": "object" }, "workspaceId": { "description": "Workspace scope for this setting. Must reference an existing workspace the caller has at least VIEW access to. Null means user-level (no workspace scope).", "maxLength": 255, "nullable": true, "type": "string" } }, "required": [ "applicationName", "content" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "customUserApplicationSetting" ], "example": "customUserApplicationSetting", "type": "string" } }, "required": [ "attributes", "type" ], "type": "object" }, "JsonApiCustomUserApplicationSettingPostOptionalIdDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingPostOptionalId" } }, "required": [ "data" ], "type": "object" }, "JsonApiDashboardPluginIn": { "description": "JSON:API representation of dashboardPlugin entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "content": { "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": { "url": "" }, "type": "object" }, "description": { "maxLength": 10000, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "dashboardPlugin" ], "example": "dashboardPlugin", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiDashboardPluginInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiDashboardPluginIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiDashboardPluginLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { "type": "string" }, "type": { "enum": [ "dashboardPlugin" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiDashboardPluginOut": { "description": "JSON:API representation of dashboardPlugin entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "content": { "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": { "url": "" }, "type": "object" }, "createdAt": { "description": "Time of the entity creation.", "example": "2023-07-20 12:30", "format": "date-time", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "description": { "maxLength": 10000, "type": "string" }, "modifiedAt": { "description": "Time of the last entity modification.", "example": "2023-07-20 12:30", "format": "date-time", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "meta": { "properties": { "origin": { "properties": { "originId": { "description": "defines id of the workspace where the entity comes from", "type": "string" }, "originType": { "description": "defines type of the origin of the entity", "enum": [ "NATIVE", "PARENT" ], "type": "string" } }, "required": [ "originId", "originType" ], "type": "object" } }, "type": "object" }, "relationships": { "properties": { "createdBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "modifiedBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "dashboardPlugin" ], "example": "dashboardPlugin", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiDashboardPluginOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiDashboardPluginOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiDashboardPluginOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiDashboardPluginOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiDashboardPluginOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiDashboardPluginOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiDashboardPluginPatch": { "description": "JSON:API representation of patching dashboardPlugin entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "content": { "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": { "url": "" }, "type": "object" }, "description": { "maxLength": 10000, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "dashboardPlugin" ], "example": "dashboardPlugin", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiDashboardPluginPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiDashboardPluginPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiDashboardPluginPostOptionalId": { "description": "JSON:API representation of dashboardPlugin entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "content": { "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": { "url": "" }, "type": "object" }, "description": { "maxLength": 10000, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "dashboardPlugin" ], "example": "dashboardPlugin", "type": "string" } }, "required": [ "type" ], "type": "object" }, "JsonApiDashboardPluginPostOptionalIdDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiDashboardPluginPostOptionalId" } }, "required": [ "data" ], "type": "object" }, "JsonApiDashboardPluginToManyLinkage": { "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "items": { "$ref": "#/components/schemas/JsonApiDashboardPluginLinkage" }, "type": "array" }, "JsonApiDataSourceIdentifierOut": { "description": "JSON:API representation of dataSourceIdentifier entity.", "properties": { "attributes": { "properties": { "name": { "maxLength": 255, "type": "string" }, "schema": { "maxLength": 255, "type": "string" }, "type": { "enum": [ "POSTGRESQL", "REDSHIFT", "VERTICA", "SNOWFLAKE", "ADS", "BIGQUERY", "MSSQL", "PRESTO", "DREMIO", "DRILL", "GREENPLUM", "AZURESQL", "SYNAPSESQL", "DATABRICKS", "GDSTORAGE", "CLICKHOUSE", "MYSQL", "MARIADB", "ORACLE", "PINOT", "SINGLESTORE", "MOTHERDUCK", "FLEXCONNECT", "STARROCKS", "ATHENA", "MONGODB", "CRATEDB", "AILAKEHOUSE", "DENODO" ], "type": "string" } }, "required": [ "name", "schema", "type" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "meta": { "properties": { "permissions": { "description": "List of valid permissions for a logged-in user.", "items": { "enum": [ "MANAGE", "USE" ], "type": "string" }, "type": "array" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "dataSourceIdentifier" ], "example": "dataSourceIdentifier", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiDataSourceIdentifierOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiDataSourceIdentifierOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiDataSourceIdentifierOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiDataSourceIn": { "description": "JSON:API representation of dataSource entity.", "properties": { "attributes": { "properties": { "alternativeDataSourceId": { "description": "Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source.", "example": "pg_local_docker-demo2", "nullable": true, "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "authenticationType": { "description": "Type of authentication used to connect to the database.", "enum": [ "USERNAME_PASSWORD", "TOKEN", "KEY_PAIR", "CLIENT_SECRET", "OIDC_PASSTHROUGH" ], "nullable": true, "type": "string" }, "cacheStrategy": { "description": "Determines how the results coming from a particular datasource should be cached.", "enum": [ "ALWAYS", "NEVER" ], "nullable": true, "type": "string" }, "clientId": { "description": "The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).", "maxLength": 255, "nullable": true, "type": "string" }, "clientSecret": { "description": "The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account).", "maxLength": 255, "nullable": true, "type": "string" }, "dateTimeSemantics": { "description": "Determines how datetime values are interpreted in data sources without native support for specifying this. Only StarRocks and AI Lakehouse data sources currently support this.", "enum": [ "LOCAL", "UTC" ], "nullable": true, "type": "string" }, "name": { "description": "User-facing name of the data source.", "maxLength": 255, "type": "string" }, "parameters": { "description": "Additional parameters to be used when connecting to the database providing the data for the data source.", "items": { "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "nullable": true, "type": "array" }, "password": { "description": "The password to use to connect to the database providing the data for the data source.", "maxLength": 255, "nullable": true, "type": "string" }, "privateKey": { "description": "The private key to use to connect to the database providing the data for the data source.", "maxLength": 15000, "nullable": true, "type": "string" }, "privateKeyPassphrase": { "description": "The passphrase used to encrypt the private key.", "maxLength": 255, "nullable": true, "type": "string" }, "schema": { "description": "The schema to use as the root of the data for the data source.", "maxLength": 255, "type": "string" }, "token": { "description": "The token to use to connect to the database providing the data for the data source (for example a BigQuery Service Account).", "maxLength": 10000, "nullable": true, "type": "string" }, "type": { "description": "Type of the database providing the data for the data source.", "enum": [ "POSTGRESQL", "REDSHIFT", "VERTICA", "SNOWFLAKE", "ADS", "BIGQUERY", "MSSQL", "PRESTO", "DREMIO", "DRILL", "GREENPLUM", "AZURESQL", "SYNAPSESQL", "DATABRICKS", "GDSTORAGE", "CLICKHOUSE", "MYSQL", "MARIADB", "ORACLE", "PINOT", "SINGLESTORE", "MOTHERDUCK", "FLEXCONNECT", "STARROCKS", "ATHENA", "MONGODB", "CRATEDB", "AILAKEHOUSE", "DENODO" ], "type": "string" }, "url": { "description": "The URL of the database providing the data for the data source.", "maxLength": 255, "nullable": true, "type": "string" }, "username": { "description": "The username to use to connect to the database providing the data for the data source.", "maxLength": 255, "nullable": true, "type": "string" } }, "required": [ "name", "schema", "type" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "dataSource" ], "example": "dataSource", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiDataSourceInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiDataSourceIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiDataSourceOut": { "description": "JSON:API representation of dataSource entity.", "properties": { "attributes": { "properties": { "alternativeDataSourceId": { "description": "Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source.", "example": "pg_local_docker-demo2", "nullable": true, "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "authenticationType": { "description": "Type of authentication used to connect to the database.", "enum": [ "USERNAME_PASSWORD", "TOKEN", "KEY_PAIR", "CLIENT_SECRET", "OIDC_PASSTHROUGH" ], "nullable": true, "type": "string" }, "cacheStrategy": { "description": "Determines how the results coming from a particular datasource should be cached.", "enum": [ "ALWAYS", "NEVER" ], "nullable": true, "type": "string" }, "clientId": { "description": "The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).", "maxLength": 255, "nullable": true, "type": "string" }, "dateTimeSemantics": { "description": "Determines how datetime values are interpreted in data sources without native support for specifying this. Only StarRocks and AI Lakehouse data sources currently support this.", "enum": [ "LOCAL", "UTC" ], "nullable": true, "type": "string" }, "decodedParameters": { "description": "Decoded parameters to be used when connecting to the database providing the data for the data source.", "items": { "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "nullable": true, "type": "array" }, "managed": { "description": "Whether the object is platform-managed and read-only.", "type": "boolean" }, "name": { "description": "User-facing name of the data source.", "maxLength": 255, "type": "string" }, "parameters": { "description": "Additional parameters to be used when connecting to the database providing the data for the data source.", "items": { "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "nullable": true, "type": "array" }, "schema": { "description": "The schema to use as the root of the data for the data source.", "maxLength": 255, "type": "string" }, "type": { "description": "Type of the database providing the data for the data source.", "enum": [ "POSTGRESQL", "REDSHIFT", "VERTICA", "SNOWFLAKE", "ADS", "BIGQUERY", "MSSQL", "PRESTO", "DREMIO", "DRILL", "GREENPLUM", "AZURESQL", "SYNAPSESQL", "DATABRICKS", "GDSTORAGE", "CLICKHOUSE", "MYSQL", "MARIADB", "ORACLE", "PINOT", "SINGLESTORE", "MOTHERDUCK", "FLEXCONNECT", "STARROCKS", "ATHENA", "MONGODB", "CRATEDB", "AILAKEHOUSE", "DENODO" ], "type": "string" }, "url": { "description": "The URL of the database providing the data for the data source.", "maxLength": 255, "nullable": true, "type": "string" }, "username": { "description": "The username to use to connect to the database providing the data for the data source.", "maxLength": 255, "nullable": true, "type": "string" } }, "required": [ "name", "schema", "type" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "meta": { "properties": { "permissions": { "description": "List of valid permissions for a logged-in user.", "items": { "enum": [ "MANAGE", "USE" ], "type": "string" }, "type": "array" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "dataSource" ], "example": "dataSource", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiDataSourceOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiDataSourceOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiDataSourceOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiDataSourceOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiDataSourceOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiDataSourceOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiDataSourcePatch": { "description": "JSON:API representation of patching dataSource entity.", "properties": { "attributes": { "properties": { "alternativeDataSourceId": { "description": "Alternative data source ID. It is a weak reference meaning data source does not have to exist. All the entities (e.g. tables) from the data source must be available also in the alternative data source. It must be present in the same organization as the data source.", "example": "pg_local_docker-demo2", "nullable": true, "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "authenticationType": { "description": "Type of authentication used to connect to the database.", "enum": [ "USERNAME_PASSWORD", "TOKEN", "KEY_PAIR", "CLIENT_SECRET", "OIDC_PASSTHROUGH" ], "nullable": true, "type": "string" }, "cacheStrategy": { "description": "Determines how the results coming from a particular datasource should be cached.", "enum": [ "ALWAYS", "NEVER" ], "nullable": true, "type": "string" }, "clientId": { "description": "The client id to use to connect to the database providing the data for the data source (for example a Databricks Service Account).", "maxLength": 255, "nullable": true, "type": "string" }, "clientSecret": { "description": "The client secret to use to connect to the database providing the data for the data source (for example a Databricks Service Account).", "maxLength": 255, "nullable": true, "type": "string" }, "dateTimeSemantics": { "description": "Determines how datetime values are interpreted in data sources without native support for specifying this. Only StarRocks and AI Lakehouse data sources currently support this.", "enum": [ "LOCAL", "UTC" ], "nullable": true, "type": "string" }, "name": { "description": "User-facing name of the data source.", "maxLength": 255, "type": "string" }, "parameters": { "description": "Additional parameters to be used when connecting to the database providing the data for the data source.", "items": { "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "nullable": true, "type": "array" }, "password": { "description": "The password to use to connect to the database providing the data for the data source.", "maxLength": 255, "nullable": true, "type": "string" }, "privateKey": { "description": "The private key to use to connect to the database providing the data for the data source.", "maxLength": 15000, "nullable": true, "type": "string" }, "privateKeyPassphrase": { "description": "The passphrase used to encrypt the private key.", "maxLength": 255, "nullable": true, "type": "string" }, "schema": { "description": "The schema to use as the root of the data for the data source.", "maxLength": 255, "type": "string" }, "token": { "description": "The token to use to connect to the database providing the data for the data source (for example a BigQuery Service Account).", "maxLength": 10000, "nullable": true, "type": "string" }, "type": { "description": "Type of the database providing the data for the data source.", "enum": [ "POSTGRESQL", "REDSHIFT", "VERTICA", "SNOWFLAKE", "ADS", "BIGQUERY", "MSSQL", "PRESTO", "DREMIO", "DRILL", "GREENPLUM", "AZURESQL", "SYNAPSESQL", "DATABRICKS", "GDSTORAGE", "CLICKHOUSE", "MYSQL", "MARIADB", "ORACLE", "PINOT", "SINGLESTORE", "MOTHERDUCK", "FLEXCONNECT", "STARROCKS", "ATHENA", "MONGODB", "CRATEDB", "AILAKEHOUSE", "DENODO" ], "type": "string" }, "url": { "description": "The URL of the database providing the data for the data source.", "maxLength": 255, "nullable": true, "type": "string" }, "username": { "description": "The username to use to connect to the database providing the data for the data source.", "maxLength": 255, "nullable": true, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "dataSource" ], "example": "dataSource", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiDataSourcePatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiDataSourcePatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiDatasetLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { "type": "string" }, "type": { "enum": [ "dataset" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiDatasetOut": { "description": "JSON:API representation of dataset entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "dataSourceTableId": { "maxLength": 255, "type": "string" }, "dataSourceTablePath": { "description": "Path to database table.", "example": [ "schema", "table" ], "items": { "maxLength": 255, "type": "string" }, "type": "array" }, "description": { "maxLength": 10000, "type": "string" }, "grain": { "items": { "properties": { "id": { "type": "string" }, "type": { "enum": [ "attribute", "date" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "type": "array" }, "precedence": { "format": "int32", "type": "integer" }, "referenceProperties": { "items": { "properties": { "identifier": { "$ref": "#/components/schemas/DatasetReferenceIdentifier" }, "multivalue": { "type": "boolean" }, "sourceColumnDataTypes": { "items": { "enum": [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN", "HLL" ], "type": "string" }, "type": "array" }, "sourceColumns": { "items": { "type": "string" }, "type": "array" }, "sources": { "items": { "$ref": "#/components/schemas/ReferenceSourceColumn" }, "type": "array" } }, "required": [ "identifier", "multivalue" ], "type": "object" }, "type": "array" }, "sql": { "properties": { "dataSourceId": { "type": "string" }, "statement": { "type": "string" } }, "required": [ "dataSourceId", "statement" ], "type": "object" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" }, "type": { "enum": [ "NORMAL", "DATE", "AUXILIARY" ], "type": "string" }, "workspaceDataFilterColumns": { "items": { "properties": { "dataType": { "enum": [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN", "HLL" ], "type": "string" }, "name": { "type": "string" } }, "required": [ "dataType", "name" ], "type": "object" }, "type": "array" }, "workspaceDataFilterReferences": { "items": { "description": "Workspace data filter reference.", "properties": { "filterColumn": { "type": "string" }, "filterColumnDataType": { "enum": [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN", "HLL" ], "type": "string" }, "filterId": { "$ref": "#/components/schemas/DatasetWorkspaceDataFilterIdentifier" } }, "required": [ "filterColumn", "filterColumnDataType", "filterId" ], "type": "object" }, "type": "array" } }, "required": [ "type" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "meta": { "properties": { "origin": { "properties": { "originId": { "description": "defines id of the workspace where the entity comes from", "type": "string" }, "originType": { "description": "defines type of the origin of the entity", "enum": [ "NATIVE", "PARENT" ], "type": "string" } }, "required": [ "originId", "originType" ], "type": "object" } }, "type": "object" }, "relationships": { "properties": { "aggregatedFacts": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAggregatedFactToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "attributes": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "facts": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiFactToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "references": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "workspaceDataFilters": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToManyLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "dataset" ], "example": "dataset", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiDatasetOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiDatasetOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiDatasetOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiDatasetOutIncludes": { "oneOf": [ { "$ref": "#/components/schemas/JsonApiAggregatedFactOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiFactOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" } ] }, "JsonApiDatasetOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiDatasetOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiDatasetOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiDatasetOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiDatasetPatch": { "description": "JSON:API representation of patching dataset entity.", "properties": { "attributes": { "properties": { "description": { "maxLength": 10000, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "dataset" ], "example": "dataset", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiDatasetPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiDatasetPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiDatasetToManyLinkage": { "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "items": { "$ref": "#/components/schemas/JsonApiDatasetLinkage" }, "type": "array" }, "JsonApiDatasetToOneLinkage": { "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonApiDatasetLinkage" } ] }, "JsonApiDocumentDatabaseInstance": { "description": "JSON:API-compatible single-resource response envelope", "properties": { "data": { "$ref": "#/components/schemas/JsonApiItemDatabaseInstance" }, "links": { "$ref": "#/components/schemas/JsonApiListLinks" } }, "required": [ "data", "links" ], "type": "object" }, "JsonApiDocumentPipeTable": { "description": "JSON:API-compatible single-resource response envelope", "properties": { "data": { "$ref": "#/components/schemas/JsonApiItemPipeTable" }, "links": { "$ref": "#/components/schemas/JsonApiListLinks" } }, "required": [ "data", "links" ], "type": "object" }, "JsonApiEntitlementOut": { "description": "JSON:API representation of entitlement entity.", "properties": { "attributes": { "properties": { "expiry": { "format": "date", "type": "string" }, "value": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "entitlement" ], "example": "entitlement", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiEntitlementOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiEntitlementOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiEntitlementOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiEntitlementOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiEntitlementOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiEntitlementOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiExportDefinitionIn": { "description": "JSON:API representation of exportDefinition entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "description": { "maxLength": 10000, "type": "string" }, "requestPayload": { "description": "JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. ", "oneOf": [ { "$ref": "#/components/schemas/VisualExportRequest" }, { "$ref": "#/components/schemas/TabularExportRequest" } ], "type": "object" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "analyticalDashboard": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "visualizationObject": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiVisualizationObjectToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "exportDefinition" ], "example": "exportDefinition", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiExportDefinitionInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiExportDefinitionIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiExportDefinitionLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { "type": "string" }, "type": { "enum": [ "exportDefinition" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiExportDefinitionOut": { "description": "JSON:API representation of exportDefinition entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "createdAt": { "description": "Time of the entity creation.", "example": "2023-07-20 12:30", "format": "date-time", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "description": { "maxLength": 10000, "type": "string" }, "modifiedAt": { "description": "Time of the last entity modification.", "example": "2023-07-20 12:30", "format": "date-time", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "requestPayload": { "description": "JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. ", "oneOf": [ { "$ref": "#/components/schemas/VisualExportRequest" }, { "$ref": "#/components/schemas/TabularExportRequest" } ], "type": "object" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "meta": { "properties": { "origin": { "properties": { "originId": { "description": "defines id of the workspace where the entity comes from", "type": "string" }, "originType": { "description": "defines type of the origin of the entity", "enum": [ "NATIVE", "PARENT" ], "type": "string" } }, "required": [ "originId", "originType" ], "type": "object" } }, "type": "object" }, "relationships": { "properties": { "analyticalDashboard": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "automation": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAutomationToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "createdBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "modifiedBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "visualizationObject": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiVisualizationObjectToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "exportDefinition" ], "example": "exportDefinition", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiExportDefinitionOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiExportDefinitionOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiExportDefinitionOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiExportDefinitionOutIncludes": { "oneOf": [ { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiAutomationOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiVisualizationObjectOutWithLinks" } ] }, "JsonApiExportDefinitionOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiExportDefinitionOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiExportDefinitionOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiExportDefinitionOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiExportDefinitionOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiExportDefinitionPatch": { "description": "JSON:API representation of patching exportDefinition entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "description": { "maxLength": 10000, "type": "string" }, "requestPayload": { "description": "JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. ", "oneOf": [ { "$ref": "#/components/schemas/VisualExportRequest" }, { "$ref": "#/components/schemas/TabularExportRequest" } ], "type": "object" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "analyticalDashboard": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "visualizationObject": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiVisualizationObjectToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "exportDefinition" ], "example": "exportDefinition", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiExportDefinitionPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiExportDefinitionPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiExportDefinitionPostOptionalId": { "description": "JSON:API representation of exportDefinition entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "description": { "maxLength": 10000, "type": "string" }, "requestPayload": { "description": "JSON content to be used as export request payload for /export/tabular and /export/visual endpoints. ", "oneOf": [ { "$ref": "#/components/schemas/VisualExportRequest" }, { "$ref": "#/components/schemas/TabularExportRequest" } ], "type": "object" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "analyticalDashboard": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "visualizationObject": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiVisualizationObjectToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "exportDefinition" ], "example": "exportDefinition", "type": "string" } }, "required": [ "type" ], "type": "object" }, "JsonApiExportDefinitionPostOptionalIdDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiExportDefinitionPostOptionalId" } }, "required": [ "data" ], "type": "object" }, "JsonApiExportDefinitionToManyLinkage": { "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "items": { "$ref": "#/components/schemas/JsonApiExportDefinitionLinkage" }, "type": "array" }, "JsonApiExportTemplateIn": { "description": "JSON:API representation of exportTemplate entity.", "properties": { "attributes": { "properties": { "dashboardSlidesTemplate": { "description": "Template for dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", "nullable": true, "properties": { "appliedOn": { "description": "Export types this template applies to.", "example": [ "PDF", "PPTX" ], "items": { "enum": [ "PDF", "PPTX" ], "type": "string" }, "minItems": 1, "type": "array" }, "contentSlide": { "$ref": "#/components/schemas/ContentSlideTemplate" }, "coverSlide": { "$ref": "#/components/schemas/CoverSlideTemplate" }, "introSlide": { "$ref": "#/components/schemas/IntroSlideTemplate" }, "sectionSlide": { "$ref": "#/components/schemas/SectionSlideTemplate" } }, "required": [ "appliedOn" ], "type": "object" }, "name": { "description": "User-facing name of the Slides template.", "maxLength": 255, "type": "string" }, "widgetSlidesTemplate": { "description": "Template for widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", "nullable": true, "properties": { "appliedOn": { "description": "Export types this template applies to.", "example": [ "PDF", "PPTX" ], "items": { "enum": [ "PDF", "PPTX" ], "type": "string" }, "minItems": 1, "type": "array" }, "contentSlide": { "$ref": "#/components/schemas/ContentSlideTemplate" } }, "required": [ "appliedOn" ], "type": "object" } }, "required": [ "name" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "exportTemplate" ], "example": "exportTemplate", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiExportTemplateInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiExportTemplateIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiExportTemplateOut": { "description": "JSON:API representation of exportTemplate entity.", "properties": { "attributes": { "properties": { "dashboardSlidesTemplate": { "description": "Template for dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", "nullable": true, "properties": { "appliedOn": { "description": "Export types this template applies to.", "example": [ "PDF", "PPTX" ], "items": { "enum": [ "PDF", "PPTX" ], "type": "string" }, "minItems": 1, "type": "array" }, "contentSlide": { "$ref": "#/components/schemas/ContentSlideTemplate" }, "coverSlide": { "$ref": "#/components/schemas/CoverSlideTemplate" }, "introSlide": { "$ref": "#/components/schemas/IntroSlideTemplate" }, "sectionSlide": { "$ref": "#/components/schemas/SectionSlideTemplate" } }, "required": [ "appliedOn" ], "type": "object" }, "name": { "description": "User-facing name of the Slides template.", "maxLength": 255, "type": "string" }, "widgetSlidesTemplate": { "description": "Template for widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", "nullable": true, "properties": { "appliedOn": { "description": "Export types this template applies to.", "example": [ "PDF", "PPTX" ], "items": { "enum": [ "PDF", "PPTX" ], "type": "string" }, "minItems": 1, "type": "array" }, "contentSlide": { "$ref": "#/components/schemas/ContentSlideTemplate" } }, "required": [ "appliedOn" ], "type": "object" } }, "required": [ "name" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "exportTemplate" ], "example": "exportTemplate", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiExportTemplateOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiExportTemplateOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiExportTemplateOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiExportTemplateOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiExportTemplateOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiExportTemplateOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiExportTemplatePatch": { "description": "JSON:API representation of patching exportTemplate entity.", "properties": { "attributes": { "properties": { "dashboardSlidesTemplate": { "description": "Template for dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", "nullable": true, "properties": { "appliedOn": { "description": "Export types this template applies to.", "example": [ "PDF", "PPTX" ], "items": { "enum": [ "PDF", "PPTX" ], "type": "string" }, "minItems": 1, "type": "array" }, "contentSlide": { "$ref": "#/components/schemas/ContentSlideTemplate" }, "coverSlide": { "$ref": "#/components/schemas/CoverSlideTemplate" }, "introSlide": { "$ref": "#/components/schemas/IntroSlideTemplate" }, "sectionSlide": { "$ref": "#/components/schemas/SectionSlideTemplate" } }, "required": [ "appliedOn" ], "type": "object" }, "name": { "description": "User-facing name of the Slides template.", "maxLength": 255, "type": "string" }, "widgetSlidesTemplate": { "description": "Template for widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", "nullable": true, "properties": { "appliedOn": { "description": "Export types this template applies to.", "example": [ "PDF", "PPTX" ], "items": { "enum": [ "PDF", "PPTX" ], "type": "string" }, "minItems": 1, "type": "array" }, "contentSlide": { "$ref": "#/components/schemas/ContentSlideTemplate" } }, "required": [ "appliedOn" ], "type": "object" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "exportTemplate" ], "example": "exportTemplate", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiExportTemplatePatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiExportTemplatePatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiExportTemplatePostOptionalId": { "description": "JSON:API representation of exportTemplate entity.", "properties": { "attributes": { "properties": { "dashboardSlidesTemplate": { "description": "Template for dashboard slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", "nullable": true, "properties": { "appliedOn": { "description": "Export types this template applies to.", "example": [ "PDF", "PPTX" ], "items": { "enum": [ "PDF", "PPTX" ], "type": "string" }, "minItems": 1, "type": "array" }, "contentSlide": { "$ref": "#/components/schemas/ContentSlideTemplate" }, "coverSlide": { "$ref": "#/components/schemas/CoverSlideTemplate" }, "introSlide": { "$ref": "#/components/schemas/IntroSlideTemplate" }, "sectionSlide": { "$ref": "#/components/schemas/SectionSlideTemplate" } }, "required": [ "appliedOn" ], "type": "object" }, "name": { "description": "User-facing name of the Slides template.", "maxLength": 255, "type": "string" }, "widgetSlidesTemplate": { "description": "Template for widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", "nullable": true, "properties": { "appliedOn": { "description": "Export types this template applies to.", "example": [ "PDF", "PPTX" ], "items": { "enum": [ "PDF", "PPTX" ], "type": "string" }, "minItems": 1, "type": "array" }, "contentSlide": { "$ref": "#/components/schemas/ContentSlideTemplate" } }, "required": [ "appliedOn" ], "type": "object" } }, "required": [ "name" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "exportTemplate" ], "example": "exportTemplate", "type": "string" } }, "required": [ "attributes", "type" ], "type": "object" }, "JsonApiExportTemplatePostOptionalIdDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiExportTemplatePostOptionalId" } }, "required": [ "data" ], "type": "object" }, "JsonApiFactLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { "type": "string" }, "type": { "enum": [ "fact" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiFactOut": { "description": "JSON:API representation of fact entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "description": { "maxLength": 10000, "type": "string" }, "isHidden": { "type": "boolean" }, "isNullable": { "type": "boolean" }, "nullValue": { "type": "string" }, "sourceColumn": { "maxLength": 255, "type": "string" }, "sourceColumnDataType": { "enum": [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN", "HLL" ], "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "meta": { "properties": { "origin": { "properties": { "originId": { "description": "defines id of the workspace where the entity comes from", "type": "string" }, "originType": { "description": "defines type of the origin of the entity", "enum": [ "NATIVE", "PARENT" ], "type": "string" } }, "required": [ "originId", "originType" ], "type": "object" } }, "type": "object" }, "relationships": { "properties": { "dataset": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiDatasetToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "fact" ], "example": "fact", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiFactOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiFactOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiFactOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiFactOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiFactOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiFactOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiFactPatch": { "description": "JSON:API representation of patching fact entity.", "properties": { "attributes": { "properties": { "description": { "maxLength": 10000, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "fact" ], "example": "fact", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiFactPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiFactPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiFactToManyLinkage": { "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "items": { "$ref": "#/components/schemas/JsonApiFactLinkage" }, "type": "array" }, "JsonApiFactToOneLinkage": { "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonApiFactLinkage" } ] }, "JsonApiFilterContextIn": { "description": "JSON:API representation of filterContext entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "content": { "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": { "identifier": { "id": "label.leaf", "type": "label" }, "someBoolProp": false }, "type": "object" }, "description": { "maxLength": 10000, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "required": [ "content" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "filterContext" ], "example": "filterContext", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiFilterContextInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiFilterContextIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiFilterContextLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { "type": "string" }, "type": { "enum": [ "filterContext" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiFilterContextOut": { "description": "JSON:API representation of filterContext entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "content": { "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": { "identifier": { "id": "label.leaf", "type": "label" }, "someBoolProp": false }, "type": "object" }, "description": { "maxLength": 10000, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "required": [ "content" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "meta": { "properties": { "origin": { "properties": { "originId": { "description": "defines id of the workspace where the entity comes from", "type": "string" }, "originType": { "description": "defines type of the origin of the entity", "enum": [ "NATIVE", "PARENT" ], "type": "string" } }, "required": [ "originId", "originType" ], "type": "object" } }, "type": "object" }, "relationships": { "properties": { "attributes": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "datasets": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "labels": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "filterContext" ], "example": "filterContext", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiFilterContextOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiFilterContextOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiFilterContextOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiFilterContextOutIncludes": { "oneOf": [ { "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" } ] }, "JsonApiFilterContextOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiFilterContextOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiFilterContextOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiFilterContextOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiFilterContextOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiFilterContextPatch": { "description": "JSON:API representation of patching filterContext entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "content": { "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": { "identifier": { "id": "label.leaf", "type": "label" }, "someBoolProp": false }, "type": "object" }, "description": { "maxLength": 10000, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "filterContext" ], "example": "filterContext", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiFilterContextPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiFilterContextPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiFilterContextPostOptionalId": { "description": "JSON:API representation of filterContext entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "content": { "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": { "identifier": { "id": "label.leaf", "type": "label" }, "someBoolProp": false }, "type": "object" }, "description": { "maxLength": 10000, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "required": [ "content" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "filterContext" ], "example": "filterContext", "type": "string" } }, "required": [ "attributes", "type" ], "type": "object" }, "JsonApiFilterContextPostOptionalIdDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiFilterContextPostOptionalId" } }, "required": [ "data" ], "type": "object" }, "JsonApiFilterContextToManyLinkage": { "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "items": { "$ref": "#/components/schemas/JsonApiFilterContextLinkage" }, "type": "array" }, "JsonApiFilterViewIn": { "description": "JSON:API representation of filterView entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "content": { "description": "The respective filter context.", "type": "object" }, "description": { "maxLength": 10000, "type": "string" }, "isDefault": { "description": "Indicator whether the filter view should by applied by default.", "type": "boolean" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "required": [ "content", "title" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "analyticalDashboard": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "user": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "filterView" ], "example": "filterView", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiFilterViewInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiFilterViewIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiFilterViewOut": { "description": "JSON:API representation of filterView entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "content": { "description": "The respective filter context.", "type": "object" }, "description": { "maxLength": 10000, "type": "string" }, "isDefault": { "description": "Indicator whether the filter view should by applied by default.", "type": "boolean" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "required": [ "content", "title" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "analyticalDashboard": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "user": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "filterView" ], "example": "filterView", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiFilterViewOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiFilterViewOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiFilterViewOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiFilterViewOutIncludes": { "oneOf": [ { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiUserOutWithLinks" } ] }, "JsonApiFilterViewOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiFilterViewOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiFilterViewOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiFilterViewOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiFilterViewOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiFilterViewPatch": { "description": "JSON:API representation of patching filterView entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "content": { "description": "The respective filter context.", "type": "object" }, "description": { "maxLength": 10000, "type": "string" }, "isDefault": { "description": "Indicator whether the filter view should by applied by default.", "type": "boolean" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "analyticalDashboard": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "user": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "filterView" ], "example": "filterView", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiFilterViewPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiFilterViewPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiIdentityProviderIn": { "description": "JSON:API representation of identityProvider entity.", "properties": { "attributes": { "properties": { "customClaimMapping": { "additionalProperties": { "type": "string" }, "description": "Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). 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.", "maxLength": 10000, "type": "object" }, "identifiers": { "description": "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.", "example": [ "gooddata.com" ], "items": { "type": "string" }, "type": "array" }, "idpType": { "description": "Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.", "enum": [ "MANAGED_IDP", "FIM_IDP", "DEX_IDP", "CUSTOM_IDP" ], "type": "string" }, "oauthClientId": { "description": "The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.", "maxLength": 255, "type": "string" }, "oauthClientSecret": { "description": "The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.", "maxLength": 255, "type": "string" }, "oauthCustomAuthAttributes": { "additionalProperties": { "type": "string" }, "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", "maxLength": 10000, "type": "object" }, "oauthCustomScopes": { "description": "List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", "items": { "maxLength": 255, "type": "string" }, "nullable": true, "type": "array" }, "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": "The location of your OIDC provider. This field is mandatory for OIDC IdP.", "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" }, "samlMetadata": { "description": "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.", "maxLength": 15000, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "identityProvider" ], "example": "identityProvider", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiIdentityProviderInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiIdentityProviderIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiIdentityProviderLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { "type": "string" }, "type": { "enum": [ "identityProvider" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiIdentityProviderOut": { "description": "JSON:API representation of identityProvider entity.", "properties": { "attributes": { "properties": { "customClaimMapping": { "additionalProperties": { "type": "string" }, "description": "Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). 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.", "maxLength": 10000, "type": "object" }, "identifiers": { "description": "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.", "example": [ "gooddata.com" ], "items": { "type": "string" }, "type": "array" }, "idpType": { "description": "Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.", "enum": [ "MANAGED_IDP", "FIM_IDP", "DEX_IDP", "CUSTOM_IDP" ], "type": "string" }, "oauthClientId": { "description": "The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.", "maxLength": 255, "type": "string" }, "oauthCustomAuthAttributes": { "additionalProperties": { "type": "string" }, "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", "maxLength": 10000, "type": "object" }, "oauthCustomScopes": { "description": "List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", "items": { "maxLength": 255, "type": "string" }, "nullable": true, "type": "array" }, "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": "The location of your OIDC provider. This field is mandatory for OIDC IdP.", "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" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "identityProvider" ], "example": "identityProvider", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiIdentityProviderOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiIdentityProviderOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiIdentityProviderOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiIdentityProviderOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiIdentityProviderOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiIdentityProviderOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiIdentityProviderPatch": { "description": "JSON:API representation of patching identityProvider entity.", "properties": { "attributes": { "properties": { "customClaimMapping": { "additionalProperties": { "type": "string" }, "description": "Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). 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.", "maxLength": 10000, "type": "object" }, "identifiers": { "description": "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.", "example": [ "gooddata.com" ], "items": { "type": "string" }, "type": "array" }, "idpType": { "description": "Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer's own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.", "enum": [ "MANAGED_IDP", "FIM_IDP", "DEX_IDP", "CUSTOM_IDP" ], "type": "string" }, "oauthClientId": { "description": "The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.", "maxLength": 255, "type": "string" }, "oauthClientSecret": { "description": "The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.", "maxLength": 255, "type": "string" }, "oauthCustomAuthAttributes": { "additionalProperties": { "type": "string" }, "description": "Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.", "maxLength": 10000, "type": "object" }, "oauthCustomScopes": { "description": "List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)", "items": { "maxLength": 255, "type": "string" }, "nullable": true, "type": "array" }, "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": "The location of your OIDC provider. This field is mandatory for OIDC IdP.", "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" }, "samlMetadata": { "description": "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.", "maxLength": 15000, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "identityProvider" ], "example": "identityProvider", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiIdentityProviderPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiIdentityProviderPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiIdentityProviderToOneLinkage": { "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonApiIdentityProviderLinkage" } ] }, "JsonApiIpAllowlistPolicyIn": { "description": "JSON:API representation of ipAllowlistPolicy entity.", "properties": { "attributes": { "properties": { "allowedSources": { "description": "Allowed source IPv4 or IPv6 addresses or CIDR ranges. The /0 and ::/0 prefixes are not allowed.", "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "allowedSources" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "userGroups": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "users": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserToManyLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "ipAllowlistPolicy" ], "example": "ipAllowlistPolicy", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiIpAllowlistPolicyInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiIpAllowlistPolicyOut": { "description": "JSON:API representation of ipAllowlistPolicy entity.", "properties": { "attributes": { "properties": { "allowedSources": { "description": "Allowed source IPv4 or IPv6 addresses or CIDR ranges. The /0 and ::/0 prefixes are not allowed.", "items": { "type": "string" }, "nullable": true, "type": "array" } }, "required": [ "allowedSources" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "userGroups": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "users": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserToManyLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "ipAllowlistPolicy" ], "example": "ipAllowlistPolicy", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiIpAllowlistPolicyOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiIpAllowlistPolicyOutIncludes": { "oneOf": [ { "$ref": "#/components/schemas/JsonApiUserOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" } ] }, "JsonApiIpAllowlistPolicyOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiIpAllowlistPolicyOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiItemDataSourceInfo": { "description": "A single JSON:API resource item", "properties": { "attributes": { "$ref": "#/components/schemas/DataSourceInfo" }, "id": { "description": "Resource identifier", "type": "string" }, "type": { "description": "Resource type", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiItemDatabaseInstance": { "description": "A single JSON:API resource item", "properties": { "attributes": { "$ref": "#/components/schemas/DatabaseInstance" }, "id": { "description": "Resource identifier", "type": "string" }, "type": { "description": "Resource type", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiItemObjectStorageInfo": { "description": "A single JSON:API resource item", "properties": { "attributes": { "$ref": "#/components/schemas/ObjectStorageInfo" }, "id": { "description": "Resource identifier", "type": "string" }, "type": { "description": "Resource type", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiItemPipeTable": { "description": "A single JSON:API resource item", "properties": { "attributes": { "$ref": "#/components/schemas/PipeTable" }, "id": { "description": "Resource identifier", "type": "string" }, "type": { "description": "Resource type", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiItemPipeTableSummary": { "description": "A single JSON:API resource item", "properties": { "attributes": { "$ref": "#/components/schemas/PipeTableSummary" }, "id": { "description": "Resource identifier", "type": "string" }, "type": { "description": "Resource type", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiItemServiceInfo": { "description": "A single JSON:API resource item", "properties": { "attributes": { "$ref": "#/components/schemas/ServiceInfo" }, "id": { "description": "Resource identifier", "type": "string" }, "type": { "description": "Resource type", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiJwkIn": { "description": "JSON:API representation of jwk entity.", "properties": { "attributes": { "properties": { "content": { "description": "Specification of the cryptographic key", "example": { "alg": "RS256", "kyt": "RSA", "use": "sig" }, "oneOf": [ { "$ref": "#/components/schemas/RsaSpecification" } ], "type": "object" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "jwk" ], "example": "jwk", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiJwkInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiJwkIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiJwkOut": { "description": "JSON:API representation of jwk entity.", "properties": { "attributes": { "properties": { "content": { "description": "Specification of the cryptographic key", "example": { "alg": "RS256", "kyt": "RSA", "use": "sig" }, "oneOf": [ { "$ref": "#/components/schemas/RsaSpecification" } ], "type": "object" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "jwk" ], "example": "jwk", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiJwkOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiJwkOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiJwkOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiJwkOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiJwkOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiJwkOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiJwkPatch": { "description": "JSON:API representation of patching jwk entity.", "properties": { "attributes": { "properties": { "content": { "description": "Specification of the cryptographic key", "example": { "alg": "RS256", "kyt": "RSA", "use": "sig" }, "oneOf": [ { "$ref": "#/components/schemas/RsaSpecification" } ], "type": "object" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "jwk" ], "example": "jwk", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiJwkPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiJwkPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiKnowledgeRecommendationIn": { "description": "JSON:API representation of knowledgeRecommendation entity.", "properties": { "attributes": { "properties": { "analyticalDashboardTitle": { "description": "Human-readable title of the analytical dashboard (denormalized for display)", "example": "Portfolio Health Insights", "maxLength": 255, "type": "string" }, "analyzedPeriod": { "description": "Analyzed time period (e.g., '2023-07' or 'July 2023')", "example": "2023-07", "maxLength": 255, "type": "string" }, "analyzedValue": { "description": "Metric value in the analyzed period (the observed value that triggered the anomaly)", "example": 2600000000.0 }, "areRelationsValid": { "type": "boolean" }, "comparisonType": { "description": "Time period for comparison", "enum": [ "MONTH", "QUARTER", "YEAR" ], "example": "MONTH", "type": "string" }, "confidence": { "description": "Confidence score (0.0 to 1.0)", "example": 0.62 }, "description": { "description": "Description of the recommendation", "maxLength": 10000, "type": "string" }, "direction": { "description": "Direction of the metric change", "enum": [ "INCREASED", "DECREASED" ], "example": "DECREASED", "type": "string" }, "metricTitle": { "description": "Human-readable title of the metric (denormalized for display)", "example": "Revenue", "maxLength": 255, "type": "string" }, "recommendations": { "description": "Structured recommendations data as JSON", "example": "{\"summary\": \"...\", \"recommendations\": [...], \"key_metrics\": [...]}", "type": "object" }, "referencePeriod": { "description": "Reference time period for comparison (e.g., '2023-06' or 'Jun 2023')", "example": "2023-06", "maxLength": 255, "type": "string" }, "referenceValue": { "description": "Metric value in the reference period", "example": 2400000000.0 }, "sourceCount": { "description": "Number of source documents used for generation", "example": 2, "format": "int32", "type": "integer" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "description": "Human-readable title for the recommendation, e.g. 'Revenue decreased vs last month'", "maxLength": 255, "type": "string" }, "widgetId": { "description": "ID of the widget where the anomaly was detected", "example": "widget-123", "maxLength": 255, "type": "string" }, "widgetName": { "description": "Name of the widget where the anomaly was detected", "example": "Revenue Trend", "maxLength": 255, "type": "string" } }, "required": [ "comparisonType", "direction", "title" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "analyticalDashboard": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "metric": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiMetricToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "required": [ "metric" ], "type": "object" }, "type": { "description": "Object type", "enum": [ "knowledgeRecommendation" ], "example": "knowledgeRecommendation", "type": "string" } }, "required": [ "attributes", "id", "relationships", "type" ], "type": "object" }, "JsonApiKnowledgeRecommendationInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiKnowledgeRecommendationOut": { "description": "JSON:API representation of knowledgeRecommendation entity.", "properties": { "attributes": { "properties": { "analyticalDashboardTitle": { "description": "Human-readable title of the analytical dashboard (denormalized for display)", "example": "Portfolio Health Insights", "maxLength": 255, "type": "string" }, "analyzedPeriod": { "description": "Analyzed time period (e.g., '2023-07' or 'July 2023')", "example": "2023-07", "maxLength": 255, "type": "string" }, "analyzedValue": { "description": "Metric value in the analyzed period (the observed value that triggered the anomaly)", "example": 2600000000.0 }, "areRelationsValid": { "type": "boolean" }, "comparisonType": { "description": "Time period for comparison", "enum": [ "MONTH", "QUARTER", "YEAR" ], "example": "MONTH", "type": "string" }, "confidence": { "description": "Confidence score (0.0 to 1.0)", "example": 0.62 }, "createdAt": { "format": "date-time", "type": "string" }, "description": { "description": "Description of the recommendation", "maxLength": 10000, "type": "string" }, "direction": { "description": "Direction of the metric change", "enum": [ "INCREASED", "DECREASED" ], "example": "DECREASED", "type": "string" }, "metricTitle": { "description": "Human-readable title of the metric (denormalized for display)", "example": "Revenue", "maxLength": 255, "type": "string" }, "recommendations": { "description": "Structured recommendations data as JSON", "example": "{\"summary\": \"...\", \"recommendations\": [...], \"key_metrics\": [...]}", "type": "object" }, "referencePeriod": { "description": "Reference time period for comparison (e.g., '2023-06' or 'Jun 2023')", "example": "2023-06", "maxLength": 255, "type": "string" }, "referenceValue": { "description": "Metric value in the reference period", "example": 2400000000.0 }, "sourceCount": { "description": "Number of source documents used for generation", "example": 2, "format": "int32", "type": "integer" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "description": "Human-readable title for the recommendation, e.g. 'Revenue decreased vs last month'", "maxLength": 255, "type": "string" }, "widgetId": { "description": "ID of the widget where the anomaly was detected", "example": "widget-123", "maxLength": 255, "type": "string" }, "widgetName": { "description": "Name of the widget where the anomaly was detected", "example": "Revenue Trend", "maxLength": 255, "type": "string" } }, "required": [ "comparisonType", "direction", "title" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "meta": { "properties": { "origin": { "properties": { "originId": { "description": "defines id of the workspace where the entity comes from", "type": "string" }, "originType": { "description": "defines type of the origin of the entity", "enum": [ "NATIVE", "PARENT" ], "type": "string" } }, "required": [ "originId", "originType" ], "type": "object" } }, "type": "object" }, "relationships": { "properties": { "analyticalDashboard": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "metric": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiMetricToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "knowledgeRecommendation" ], "example": "knowledgeRecommendation", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiKnowledgeRecommendationOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiKnowledgeRecommendationOutIncludes": { "oneOf": [ { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" } ] }, "JsonApiKnowledgeRecommendationOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiKnowledgeRecommendationOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiKnowledgeRecommendationPatch": { "description": "JSON:API representation of patching knowledgeRecommendation entity.", "properties": { "attributes": { "properties": { "analyticalDashboardTitle": { "description": "Human-readable title of the analytical dashboard (denormalized for display)", "example": "Portfolio Health Insights", "maxLength": 255, "type": "string" }, "analyzedPeriod": { "description": "Analyzed time period (e.g., '2023-07' or 'July 2023')", "example": "2023-07", "maxLength": 255, "type": "string" }, "analyzedValue": { "description": "Metric value in the analyzed period (the observed value that triggered the anomaly)", "example": 2600000000.0 }, "areRelationsValid": { "type": "boolean" }, "comparisonType": { "description": "Time period for comparison", "enum": [ "MONTH", "QUARTER", "YEAR" ], "example": "MONTH", "type": "string" }, "confidence": { "description": "Confidence score (0.0 to 1.0)", "example": 0.62 }, "description": { "description": "Description of the recommendation", "maxLength": 10000, "type": "string" }, "direction": { "description": "Direction of the metric change", "enum": [ "INCREASED", "DECREASED" ], "example": "DECREASED", "type": "string" }, "metricTitle": { "description": "Human-readable title of the metric (denormalized for display)", "example": "Revenue", "maxLength": 255, "type": "string" }, "recommendations": { "description": "Structured recommendations data as JSON", "example": "{\"summary\": \"...\", \"recommendations\": [...], \"key_metrics\": [...]}", "type": "object" }, "referencePeriod": { "description": "Reference time period for comparison (e.g., '2023-06' or 'Jun 2023')", "example": "2023-06", "maxLength": 255, "type": "string" }, "referenceValue": { "description": "Metric value in the reference period", "example": 2400000000.0 }, "sourceCount": { "description": "Number of source documents used for generation", "example": 2, "format": "int32", "type": "integer" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "description": "Human-readable title for the recommendation, e.g. 'Revenue decreased vs last month'", "maxLength": 255, "type": "string" }, "widgetId": { "description": "ID of the widget where the anomaly was detected", "example": "widget-123", "maxLength": 255, "type": "string" }, "widgetName": { "description": "Name of the widget where the anomaly was detected", "example": "Revenue Trend", "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "analyticalDashboard": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "metric": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiMetricToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "knowledgeRecommendation" ], "example": "knowledgeRecommendation", "type": "string" } }, "required": [ "attributes", "id", "relationships", "type" ], "type": "object" }, "JsonApiKnowledgeRecommendationPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiKnowledgeRecommendationPostOptionalId": { "description": "JSON:API representation of knowledgeRecommendation entity.", "properties": { "attributes": { "properties": { "analyticalDashboardTitle": { "description": "Human-readable title of the analytical dashboard (denormalized for display)", "example": "Portfolio Health Insights", "maxLength": 255, "type": "string" }, "analyzedPeriod": { "description": "Analyzed time period (e.g., '2023-07' or 'July 2023')", "example": "2023-07", "maxLength": 255, "type": "string" }, "analyzedValue": { "description": "Metric value in the analyzed period (the observed value that triggered the anomaly)", "example": 2600000000.0 }, "areRelationsValid": { "type": "boolean" }, "comparisonType": { "description": "Time period for comparison", "enum": [ "MONTH", "QUARTER", "YEAR" ], "example": "MONTH", "type": "string" }, "confidence": { "description": "Confidence score (0.0 to 1.0)", "example": 0.62 }, "description": { "description": "Description of the recommendation", "maxLength": 10000, "type": "string" }, "direction": { "description": "Direction of the metric change", "enum": [ "INCREASED", "DECREASED" ], "example": "DECREASED", "type": "string" }, "metricTitle": { "description": "Human-readable title of the metric (denormalized for display)", "example": "Revenue", "maxLength": 255, "type": "string" }, "recommendations": { "description": "Structured recommendations data as JSON", "example": "{\"summary\": \"...\", \"recommendations\": [...], \"key_metrics\": [...]}", "type": "object" }, "referencePeriod": { "description": "Reference time period for comparison (e.g., '2023-06' or 'Jun 2023')", "example": "2023-06", "maxLength": 255, "type": "string" }, "referenceValue": { "description": "Metric value in the reference period", "example": 2400000000.0 }, "sourceCount": { "description": "Number of source documents used for generation", "example": 2, "format": "int32", "type": "integer" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "description": "Human-readable title for the recommendation, e.g. 'Revenue decreased vs last month'", "maxLength": 255, "type": "string" }, "widgetId": { "description": "ID of the widget where the anomaly was detected", "example": "widget-123", "maxLength": 255, "type": "string" }, "widgetName": { "description": "Name of the widget where the anomaly was detected", "example": "Revenue Trend", "maxLength": 255, "type": "string" } }, "required": [ "comparisonType", "direction", "title" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "analyticalDashboard": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "metric": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiMetricToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "required": [ "metric" ], "type": "object" }, "type": { "description": "Object type", "enum": [ "knowledgeRecommendation" ], "example": "knowledgeRecommendation", "type": "string" } }, "required": [ "attributes", "relationships", "type" ], "type": "object" }, "JsonApiKnowledgeRecommendationPostOptionalIdDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPostOptionalId" } }, "required": [ "data" ], "type": "object" }, "JsonApiLabelLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { "type": "string" }, "type": { "enum": [ "label" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiLabelOut": { "description": "JSON:API representation of label entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "description": { "maxLength": 10000, "type": "string" }, "geoAreaConfig": { "description": "Configuration specific to geo area labels.", "properties": { "collection": { "$ref": "#/components/schemas/GeoCollectionIdentifier" } }, "required": [ "collection" ], "type": "object" }, "isHidden": { "type": "boolean" }, "isNullable": { "type": "boolean" }, "locale": { "type": "string" }, "nullValue": { "type": "string" }, "primary": { "type": "boolean" }, "sourceColumn": { "maxLength": 255, "type": "string" }, "sourceColumnDataType": { "enum": [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN", "HLL" ], "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" }, "translations": { "items": { "properties": { "locale": { "type": "string" }, "sourceColumn": { "type": "string" } }, "required": [ "locale", "sourceColumn" ], "type": "object" }, "type": "array" }, "valueType": { "enum": [ "TEXT", "HYPERLINK", "GEO", "GEO_LONGITUDE", "GEO_LATITUDE", "GEO_AREA", "GEO_ICON", "IMAGE", "HYPERLOGLOG" ], "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "meta": { "properties": { "origin": { "properties": { "originId": { "description": "defines id of the workspace where the entity comes from", "type": "string" }, "originType": { "description": "defines type of the origin of the entity", "enum": [ "NATIVE", "PARENT" ], "type": "string" } }, "required": [ "originId", "originType" ], "type": "object" } }, "type": "object" }, "relationships": { "properties": { "attribute": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAttributeToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "label" ], "example": "label", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiLabelOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiLabelOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiLabelOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiLabelOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiLabelOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiLabelPatch": { "description": "JSON:API representation of patching label entity.", "properties": { "attributes": { "properties": { "description": { "maxLength": 10000, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "label" ], "example": "label", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiLabelPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiLabelPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiLabelToManyLinkage": { "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "items": { "$ref": "#/components/schemas/JsonApiLabelLinkage" }, "type": "array" }, "JsonApiLabelToOneLinkage": { "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonApiLabelLinkage" } ] }, "JsonApiListDocumentDataSourceInfo": { "description": "JSON:API-compatible list response envelope", "properties": { "data": { "description": "Array of resource items", "items": { "$ref": "#/components/schemas/JsonApiItemDataSourceInfo" }, "type": "array" }, "links": { "$ref": "#/components/schemas/JsonApiListLinks" }, "meta": { "$ref": "#/components/schemas/JsonApiListMeta" } }, "required": [ "data", "links" ], "type": "object" }, "JsonApiListDocumentDatabaseInstance": { "description": "JSON:API-compatible list response envelope", "properties": { "data": { "description": "Array of resource items", "items": { "$ref": "#/components/schemas/JsonApiItemDatabaseInstance" }, "type": "array" }, "links": { "$ref": "#/components/schemas/JsonApiListLinks" }, "meta": { "$ref": "#/components/schemas/JsonApiListMeta" } }, "required": [ "data", "links" ], "type": "object" }, "JsonApiListDocumentObjectStorageInfo": { "description": "JSON:API-compatible list response envelope", "properties": { "data": { "description": "Array of resource items", "items": { "$ref": "#/components/schemas/JsonApiItemObjectStorageInfo" }, "type": "array" }, "links": { "$ref": "#/components/schemas/JsonApiListLinks" }, "meta": { "$ref": "#/components/schemas/JsonApiListMeta" } }, "required": [ "data", "links" ], "type": "object" }, "JsonApiListDocumentPipeTableSummary": { "description": "JSON:API-compatible list response envelope", "properties": { "data": { "description": "Array of resource items", "items": { "$ref": "#/components/schemas/JsonApiItemPipeTableSummary" }, "type": "array" }, "links": { "$ref": "#/components/schemas/JsonApiListLinks" }, "meta": { "$ref": "#/components/schemas/JsonApiListMeta" } }, "required": [ "data", "links" ], "type": "object" }, "JsonApiListDocumentServiceInfo": { "description": "JSON:API-compatible list response envelope", "properties": { "data": { "description": "Array of resource items", "items": { "$ref": "#/components/schemas/JsonApiItemServiceInfo" }, "type": "array" }, "links": { "$ref": "#/components/schemas/JsonApiListLinks" }, "meta": { "$ref": "#/components/schemas/JsonApiListMeta" } }, "required": [ "data", "links" ], "type": "object" }, "JsonApiListLinks": { "description": "Links object for a list response", "properties": { "self": { "description": "The URL of this response", "type": "string" } }, "required": [ "self" ], "type": "object" }, "JsonApiListMeta": { "description": "Metadata for a paginated list response", "properties": { "page": { "$ref": "#/components/schemas/JsonApiPageInfo" } }, "required": [ "page" ], "type": "object" }, "JsonApiLlmProviderIn": { "description": "LLM Provider configuration for connecting to LLM services.", "properties": { "attributes": { "properties": { "defaultModelId": { "description": "Required ID of the default model to use from the models list.", "maxLength": 255, "nullable": true, "type": "string" }, "description": { "description": "Description of the LLM Provider.", "maxLength": 10000, "nullable": true, "type": "string" }, "models": { "description": "List of LLM models available for this provider.", "items": { "description": "LLM Model configuration (id, family) within a provider.", "properties": { "family": { "description": "Family of LLM models.", "enum": [ "OPENAI", "ANTHROPIC", "META", "MISTRAL", "AMAZON", "GOOGLE", "COHERE", "UNKNOWN" ], "type": "string" }, "id": { "description": "Unique identifier of the model (e.g., gpt-5.3, claude-4.6).", "maxLength": 255, "type": "string" } }, "required": [ "family", "id" ], "type": "object" }, "nullable": true, "type": "array" }, "name": { "maxLength": 255, "nullable": true, "type": "string" }, "providerConfig": { "description": "Provider-specific configuration including authentication.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OpenAIProviderConfig" }, { "$ref": "#/components/schemas/AzureFoundryProviderConfig" }, { "$ref": "#/components/schemas/AwsBedrockProviderConfig" }, { "$ref": "#/components/schemas/AnthropicProviderConfig" } ], "type": "object" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "llmProvider" ], "example": "llmProvider", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiLlmProviderInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiLlmProviderIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiLlmProviderOut": { "description": "LLM Provider configuration for connecting to LLM services.", "properties": { "attributes": { "properties": { "defaultModelId": { "description": "Required ID of the default model to use from the models list.", "maxLength": 255, "nullable": true, "type": "string" }, "description": { "description": "Description of the LLM Provider.", "maxLength": 10000, "nullable": true, "type": "string" }, "models": { "description": "List of LLM models available for this provider.", "items": { "description": "LLM Model configuration (id, family) within a provider.", "properties": { "family": { "description": "Family of LLM models.", "enum": [ "OPENAI", "ANTHROPIC", "META", "MISTRAL", "AMAZON", "GOOGLE", "COHERE", "UNKNOWN" ], "type": "string" }, "id": { "description": "Unique identifier of the model (e.g., gpt-5.3, claude-4.6).", "maxLength": 255, "type": "string" } }, "required": [ "family", "id" ], "type": "object" }, "nullable": true, "type": "array" }, "name": { "maxLength": 255, "nullable": true, "type": "string" }, "providerConfig": { "description": "Provider-specific configuration including authentication.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OpenAIProviderConfig" }, { "$ref": "#/components/schemas/AzureFoundryProviderConfig" }, { "$ref": "#/components/schemas/AwsBedrockProviderConfig" }, { "$ref": "#/components/schemas/AnthropicProviderConfig" } ], "type": "object" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "llmProvider" ], "example": "llmProvider", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiLlmProviderOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiLlmProviderOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiLlmProviderOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiLlmProviderOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiLlmProviderOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiLlmProviderOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiLlmProviderPatch": { "description": "LLM Provider configuration for connecting to LLM services.", "properties": { "attributes": { "properties": { "defaultModelId": { "description": "Required ID of the default model to use from the models list.", "maxLength": 255, "nullable": true, "type": "string" }, "description": { "description": "Description of the LLM Provider.", "maxLength": 10000, "nullable": true, "type": "string" }, "models": { "description": "List of LLM models available for this provider.", "items": { "description": "LLM Model configuration (id, family) within a provider.", "properties": { "family": { "description": "Family of LLM models.", "enum": [ "OPENAI", "ANTHROPIC", "META", "MISTRAL", "AMAZON", "GOOGLE", "COHERE", "UNKNOWN" ], "type": "string" }, "id": { "description": "Unique identifier of the model (e.g., gpt-5.3, claude-4.6).", "maxLength": 255, "type": "string" } }, "required": [ "family", "id" ], "type": "object" }, "nullable": true, "type": "array" }, "name": { "maxLength": 255, "nullable": true, "type": "string" }, "providerConfig": { "description": "Provider-specific configuration including authentication.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OpenAIProviderConfig" }, { "$ref": "#/components/schemas/AzureFoundryProviderConfig" }, { "$ref": "#/components/schemas/AwsBedrockProviderConfig" }, { "$ref": "#/components/schemas/AnthropicProviderConfig" } ], "type": "object" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "llmProvider" ], "example": "llmProvider", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiLlmProviderPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiLlmProviderPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiMemoryItemIn": { "description": "JSON:API representation of memoryItem entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "description": { "maxLength": 10000, "type": "string" }, "instruction": { "description": "The text that will be injected into the system prompt", "maxLength": 255, "type": "string" }, "isDisabled": { "description": "Whether memory item is disabled", "type": "boolean" }, "keywords": { "description": "Set of unique strings used for semantic similarity filtering", "items": { "type": "string" }, "type": "array" }, "strategy": { "description": "Strategy defining when the memory item should be applied", "enum": [ "ALWAYS", "AUTO" ], "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "required": [ "instruction", "strategy" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "memoryItem" ], "example": "memoryItem", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiMemoryItemInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiMemoryItemIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiMemoryItemOut": { "description": "JSON:API representation of memoryItem entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "createdAt": { "description": "Time of the entity creation.", "example": "2023-07-20 12:30", "format": "date-time", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "description": { "maxLength": 10000, "type": "string" }, "instruction": { "description": "The text that will be injected into the system prompt", "maxLength": 255, "type": "string" }, "isDisabled": { "description": "Whether memory item is disabled", "type": "boolean" }, "keywords": { "description": "Set of unique strings used for semantic similarity filtering", "items": { "type": "string" }, "type": "array" }, "modifiedAt": { "description": "Time of the last entity modification.", "example": "2023-07-20 12:30", "format": "date-time", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "strategy": { "description": "Strategy defining when the memory item should be applied", "enum": [ "ALWAYS", "AUTO" ], "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "required": [ "instruction", "strategy" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "meta": { "properties": { "origin": { "properties": { "originId": { "description": "defines id of the workspace where the entity comes from", "type": "string" }, "originType": { "description": "defines type of the origin of the entity", "enum": [ "NATIVE", "PARENT" ], "type": "string" } }, "required": [ "originId", "originType" ], "type": "object" } }, "type": "object" }, "relationships": { "properties": { "createdBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "modifiedBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "memoryItem" ], "example": "memoryItem", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiMemoryItemOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiMemoryItemOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiMemoryItemOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiMemoryItemOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiMemoryItemOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiMemoryItemOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiMemoryItemPatch": { "description": "JSON:API representation of patching memoryItem entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "description": { "maxLength": 10000, "type": "string" }, "instruction": { "description": "The text that will be injected into the system prompt", "maxLength": 255, "type": "string" }, "isDisabled": { "description": "Whether memory item is disabled", "type": "boolean" }, "keywords": { "description": "Set of unique strings used for semantic similarity filtering", "items": { "type": "string" }, "type": "array" }, "strategy": { "description": "Strategy defining when the memory item should be applied", "enum": [ "ALWAYS", "AUTO" ], "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "memoryItem" ], "example": "memoryItem", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiMemoryItemPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiMemoryItemPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiMemoryItemPostOptionalId": { "description": "JSON:API representation of memoryItem entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "description": { "maxLength": 10000, "type": "string" }, "instruction": { "description": "The text that will be injected into the system prompt", "maxLength": 255, "type": "string" }, "isDisabled": { "description": "Whether memory item is disabled", "type": "boolean" }, "keywords": { "description": "Set of unique strings used for semantic similarity filtering", "items": { "type": "string" }, "type": "array" }, "strategy": { "description": "Strategy defining when the memory item should be applied", "enum": [ "ALWAYS", "AUTO" ], "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "required": [ "instruction", "strategy" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "memoryItem" ], "example": "memoryItem", "type": "string" } }, "required": [ "attributes", "type" ], "type": "object" }, "JsonApiMemoryItemPostOptionalIdDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiMemoryItemPostOptionalId" } }, "required": [ "data" ], "type": "object" }, "JsonApiMetricIn": { "description": "JSON:API representation of metric entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "content": { "properties": { "format": { "description": "Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:] for raw filter value passthrough. Currency tokens: [$CURRENCY:] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user's format locale. Single-value filters only; multi-value filters use fallback values.", "maxLength": 2048, "nullable": true, "type": "string" }, "maql": { "maxLength": 10000, "type": "string" }, "metricType": { "description": "Categorizes metric semantics (e.g., currency).", "enum": [ "UNSPECIFIED", "CURRENCY" ], "type": "string" } }, "required": [ "maql" ], "type": "object" }, "description": { "maxLength": 10000, "type": "string" }, "isHidden": { "type": "boolean" }, "isHiddenFromKda": { "type": "boolean" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "required": [ "content" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "metric" ], "example": "metric", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiMetricInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiMetricIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiMetricLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { "type": "string" }, "type": { "enum": [ "metric" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiMetricOut": { "description": "JSON:API representation of metric entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "certification": { "description": "Certification status of the entity.", "enum": [ "CERTIFIED" ], "type": "string" }, "certificationMessage": { "description": "Optional message associated with the certification.", "nullable": true, "type": "string" }, "certifiedAt": { "description": "Time when the certification was set.", "example": "2023-07-20 12:30", "format": "date-time", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "content": { "properties": { "format": { "description": "Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:] for raw filter value passthrough. Currency tokens: [$CURRENCY:] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user's format locale. Single-value filters only; multi-value filters use fallback values.", "maxLength": 2048, "nullable": true, "type": "string" }, "maql": { "maxLength": 10000, "type": "string" }, "metricType": { "description": "Categorizes metric semantics (e.g., currency).", "enum": [ "UNSPECIFIED", "CURRENCY" ], "type": "string" } }, "required": [ "maql" ], "type": "object" }, "createdAt": { "description": "Time of the entity creation.", "example": "2023-07-20 12:30", "format": "date-time", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "description": { "maxLength": 10000, "type": "string" }, "isHidden": { "type": "boolean" }, "isHiddenFromKda": { "type": "boolean" }, "modifiedAt": { "description": "Time of the last entity modification.", "example": "2023-07-20 12:30", "format": "date-time", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "required": [ "content" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "meta": { "properties": { "origin": { "properties": { "originId": { "description": "defines id of the workspace where the entity comes from", "type": "string" }, "originType": { "description": "defines type of the origin of the entity", "enum": [ "NATIVE", "PARENT" ], "type": "string" } }, "required": [ "originId", "originType" ], "type": "object" } }, "type": "object" }, "relationships": { "properties": { "attributes": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "certifiedBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "createdBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "datasets": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "facts": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiFactToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "labels": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "metrics": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiMetricToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "modifiedBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "parameters": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiParameterToManyLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "metric" ], "example": "metric", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiMetricOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiMetricOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiMetricOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiMetricOutIncludes": { "oneOf": [ { "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiFactOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiParameterOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" } ] }, "JsonApiMetricOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiMetricOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiMetricOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiMetricOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiMetricPatch": { "description": "JSON:API representation of patching metric entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "content": { "properties": { "format": { "description": "Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:] for raw filter value passthrough. Currency tokens: [$CURRENCY:] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user's format locale. Single-value filters only; multi-value filters use fallback values.", "maxLength": 2048, "nullable": true, "type": "string" }, "maql": { "maxLength": 10000, "type": "string" }, "metricType": { "description": "Categorizes metric semantics (e.g., currency).", "enum": [ "UNSPECIFIED", "CURRENCY" ], "type": "string" } }, "required": [ "maql" ], "type": "object" }, "description": { "maxLength": 10000, "type": "string" }, "isHidden": { "type": "boolean" }, "isHiddenFromKda": { "type": "boolean" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "metric" ], "example": "metric", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiMetricPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiMetricPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiMetricPostOptionalId": { "description": "JSON:API representation of metric entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "content": { "properties": { "format": { "description": "Excel-like format string with optional dynamic tokens. Filter value tokens: [$FILTER:] for raw filter value passthrough. Currency tokens: [$CURRENCY:] for currency symbol, with optional forms :symbol, :narrow, :code, :name. Locale abbreviations: [$K], [$M], [$B], [$T] for locale-specific scale abbreviations. Tokens are resolved at execution time based on AFM filters and user's format locale. Single-value filters only; multi-value filters use fallback values.", "maxLength": 2048, "nullable": true, "type": "string" }, "maql": { "maxLength": 10000, "type": "string" }, "metricType": { "description": "Categorizes metric semantics (e.g., currency).", "enum": [ "UNSPECIFIED", "CURRENCY" ], "type": "string" } }, "required": [ "maql" ], "type": "object" }, "description": { "maxLength": 10000, "type": "string" }, "isHidden": { "type": "boolean" }, "isHiddenFromKda": { "type": "boolean" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "required": [ "content" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "metric" ], "example": "metric", "type": "string" } }, "required": [ "attributes", "type" ], "type": "object" }, "JsonApiMetricPostOptionalIdDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiMetricPostOptionalId" } }, "required": [ "data" ], "type": "object" }, "JsonApiMetricToManyLinkage": { "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "items": { "$ref": "#/components/schemas/JsonApiMetricLinkage" }, "type": "array" }, "JsonApiMetricToOneLinkage": { "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonApiMetricLinkage" } ] }, "JsonApiNotificationChannelIdentifierOut": { "description": "JSON:API representation of notificationChannelIdentifier entity.", "properties": { "attributes": { "properties": { "allowedRecipients": { "description": "Allowed recipients of notifications from this channel.\nCREATOR - only the creator\nINTERNAL - all users within the organization\nEXTERNAL - all recipients including those outside the organization\n", "enum": [ "CREATOR", "INTERNAL", "EXTERNAL" ], "type": "string" }, "description": { "maxLength": 10000, "nullable": true, "type": "string" }, "destinationType": { "enum": [ "WEBHOOK", "SMTP", "DEFAULT_SMTP", "IN_PLATFORM" ], "type": "string" }, "name": { "maxLength": 255, "nullable": true, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "notificationChannelIdentifier" ], "example": "notificationChannelIdentifier", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiNotificationChannelIdentifierOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiNotificationChannelIdentifierOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiNotificationChannelIdentifierOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiNotificationChannelIn": { "description": "JSON:API representation of notificationChannel entity.", "properties": { "attributes": { "properties": { "allowedRecipients": { "description": "Allowed recipients of notifications from this channel.\nCREATOR - only the creator\nINTERNAL - all users within the organization\nEXTERNAL - all recipients including those outside the organization\n", "enum": [ "CREATOR", "INTERNAL", "EXTERNAL" ], "type": "string" }, "customDashboardUrl": { "description": "Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are:\n{workspaceId}\n{dashboardId}\n{automationId}\n{asOfDate}\n", "maxLength": 255, "type": "string" }, "dashboardLinkVisibility": { "description": "Dashboard link visibility in notifications.\nHIDDEN - the link will not be included\nINTERNAL_ONLY - only internal users will see the link\nALL - all users will see the link\n", "enum": [ "HIDDEN", "INTERNAL_ONLY", "ALL" ], "type": "string" }, "description": { "maxLength": 10000, "nullable": true, "type": "string" }, "destination": { "description": "The destination where the notifications are to be sent.", "oneOf": [ { "$ref": "#/components/schemas/DefaultSmtp" }, { "$ref": "#/components/schemas/InPlatform" }, { "$ref": "#/components/schemas/Smtp" }, { "$ref": "#/components/schemas/Webhook" } ] }, "inPlatformNotification": { "description": "In-platform notifications configuration. No effect if the destination type is IN_PLATFORM.\nDISABLED - in-platform notifications are not sent\nENABLED - in-platform notifications are sent in addition to the regular notifications\n", "enum": [ "DISABLED", "ENABLED" ], "type": "string" }, "name": { "maxLength": 255, "nullable": true, "type": "string" }, "notificationSource": { "description": "Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are:\n{{workspaceId}}\n{{workspaceName}}\n{{workspaceDescription}}\n{{dashboardId}}\n{{dashboardName}}\n{{dashboardDescription}}\n", "maxLength": 10000, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "notificationChannel" ], "example": "notificationChannel", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiNotificationChannelInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiNotificationChannelIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiNotificationChannelLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { "type": "string" }, "type": { "enum": [ "notificationChannel" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiNotificationChannelOut": { "description": "JSON:API representation of notificationChannel entity.", "properties": { "attributes": { "properties": { "allowedRecipients": { "description": "Allowed recipients of notifications from this channel.\nCREATOR - only the creator\nINTERNAL - all users within the organization\nEXTERNAL - all recipients including those outside the organization\n", "enum": [ "CREATOR", "INTERNAL", "EXTERNAL" ], "type": "string" }, "customDashboardUrl": { "description": "Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are:\n{workspaceId}\n{dashboardId}\n{automationId}\n{asOfDate}\n", "maxLength": 255, "type": "string" }, "dashboardLinkVisibility": { "description": "Dashboard link visibility in notifications.\nHIDDEN - the link will not be included\nINTERNAL_ONLY - only internal users will see the link\nALL - all users will see the link\n", "enum": [ "HIDDEN", "INTERNAL_ONLY", "ALL" ], "type": "string" }, "description": { "maxLength": 10000, "nullable": true, "type": "string" }, "destination": { "description": "The destination where the notifications are to be sent.", "oneOf": [ { "$ref": "#/components/schemas/DefaultSmtp" }, { "$ref": "#/components/schemas/InPlatform" }, { "$ref": "#/components/schemas/Smtp" }, { "$ref": "#/components/schemas/Webhook" } ] }, "destinationType": { "enum": [ "WEBHOOK", "SMTP", "DEFAULT_SMTP", "IN_PLATFORM" ], "nullable": true, "type": "string" }, "inPlatformNotification": { "description": "In-platform notifications configuration. No effect if the destination type is IN_PLATFORM.\nDISABLED - in-platform notifications are not sent\nENABLED - in-platform notifications are sent in addition to the regular notifications\n", "enum": [ "DISABLED", "ENABLED" ], "type": "string" }, "name": { "maxLength": 255, "nullable": true, "type": "string" }, "notificationSource": { "description": "Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are:\n{{workspaceId}}\n{{workspaceName}}\n{{workspaceDescription}}\n{{dashboardId}}\n{{dashboardName}}\n{{dashboardDescription}}\n", "maxLength": 10000, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "notificationChannel" ], "example": "notificationChannel", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiNotificationChannelOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiNotificationChannelOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiNotificationChannelOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiNotificationChannelOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiNotificationChannelOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiNotificationChannelOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiNotificationChannelPatch": { "description": "JSON:API representation of patching notificationChannel entity.", "properties": { "attributes": { "properties": { "allowedRecipients": { "description": "Allowed recipients of notifications from this channel.\nCREATOR - only the creator\nINTERNAL - all users within the organization\nEXTERNAL - all recipients including those outside the organization\n", "enum": [ "CREATOR", "INTERNAL", "EXTERNAL" ], "type": "string" }, "customDashboardUrl": { "description": "Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are:\n{workspaceId}\n{dashboardId}\n{automationId}\n{asOfDate}\n", "maxLength": 255, "type": "string" }, "dashboardLinkVisibility": { "description": "Dashboard link visibility in notifications.\nHIDDEN - the link will not be included\nINTERNAL_ONLY - only internal users will see the link\nALL - all users will see the link\n", "enum": [ "HIDDEN", "INTERNAL_ONLY", "ALL" ], "type": "string" }, "description": { "maxLength": 10000, "nullable": true, "type": "string" }, "destination": { "description": "The destination where the notifications are to be sent.", "oneOf": [ { "$ref": "#/components/schemas/DefaultSmtp" }, { "$ref": "#/components/schemas/InPlatform" }, { "$ref": "#/components/schemas/Smtp" }, { "$ref": "#/components/schemas/Webhook" } ] }, "inPlatformNotification": { "description": "In-platform notifications configuration. No effect if the destination type is IN_PLATFORM.\nDISABLED - in-platform notifications are not sent\nENABLED - in-platform notifications are sent in addition to the regular notifications\n", "enum": [ "DISABLED", "ENABLED" ], "type": "string" }, "name": { "maxLength": 255, "nullable": true, "type": "string" }, "notificationSource": { "description": "Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are:\n{{workspaceId}}\n{{workspaceName}}\n{{workspaceDescription}}\n{{dashboardId}}\n{{dashboardName}}\n{{dashboardDescription}}\n", "maxLength": 10000, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "notificationChannel" ], "example": "notificationChannel", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiNotificationChannelPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiNotificationChannelPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiNotificationChannelPostOptionalId": { "description": "JSON:API representation of notificationChannel entity.", "properties": { "attributes": { "properties": { "allowedRecipients": { "description": "Allowed recipients of notifications from this channel.\nCREATOR - only the creator\nINTERNAL - all users within the organization\nEXTERNAL - all recipients including those outside the organization\n", "enum": [ "CREATOR", "INTERNAL", "EXTERNAL" ], "type": "string" }, "customDashboardUrl": { "description": "Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are:\n{workspaceId}\n{dashboardId}\n{automationId}\n{asOfDate}\n", "maxLength": 255, "type": "string" }, "dashboardLinkVisibility": { "description": "Dashboard link visibility in notifications.\nHIDDEN - the link will not be included\nINTERNAL_ONLY - only internal users will see the link\nALL - all users will see the link\n", "enum": [ "HIDDEN", "INTERNAL_ONLY", "ALL" ], "type": "string" }, "description": { "maxLength": 10000, "nullable": true, "type": "string" }, "destination": { "description": "The destination where the notifications are to be sent.", "oneOf": [ { "$ref": "#/components/schemas/DefaultSmtp" }, { "$ref": "#/components/schemas/InPlatform" }, { "$ref": "#/components/schemas/Smtp" }, { "$ref": "#/components/schemas/Webhook" } ] }, "inPlatformNotification": { "description": "In-platform notifications configuration. No effect if the destination type is IN_PLATFORM.\nDISABLED - in-platform notifications are not sent\nENABLED - in-platform notifications are sent in addition to the regular notifications\n", "enum": [ "DISABLED", "ENABLED" ], "type": "string" }, "name": { "maxLength": 255, "nullable": true, "type": "string" }, "notificationSource": { "description": "Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are:\n{{workspaceId}}\n{{workspaceName}}\n{{workspaceDescription}}\n{{dashboardId}}\n{{dashboardName}}\n{{dashboardDescription}}\n", "maxLength": 10000, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "notificationChannel" ], "example": "notificationChannel", "type": "string" } }, "required": [ "type" ], "type": "object" }, "JsonApiNotificationChannelPostOptionalIdDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiNotificationChannelPostOptionalId" } }, "required": [ "data" ], "type": "object" }, "JsonApiNotificationChannelToOneLinkage": { "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonApiNotificationChannelLinkage" } ] }, "JsonApiOrgMemoryItemIn": { "description": "Organization-scoped AI memory item.", "properties": { "attributes": { "properties": { "description": { "maxLength": 10000, "nullable": true, "type": "string" }, "instruction": { "description": "The text that will be injected into the system prompt", "maxLength": 255, "type": "string" }, "isDisabled": { "description": "Whether memory item is disabled", "type": "boolean" }, "keywords": { "description": "Set of unique strings used for semantic similarity filtering", "items": { "type": "string" }, "type": "array" }, "strategy": { "description": "Strategy defining when the memory item should be applied", "enum": [ "ALWAYS", "AUTO" ], "type": "string" }, "title": { "maxLength": 255, "nullable": true, "type": "string" } }, "required": [ "instruction", "strategy" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "orgMemoryItem" ], "example": "orgMemoryItem", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiOrgMemoryItemInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiOrgMemoryItemIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiOrgMemoryItemOut": { "description": "Organization-scoped AI memory item.", "properties": { "attributes": { "properties": { "createdAt": { "description": "Time of the entity creation.", "example": "2023-07-20 12:30", "format": "date-time", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "description": { "maxLength": 10000, "nullable": true, "type": "string" }, "instruction": { "description": "The text that will be injected into the system prompt", "maxLength": 255, "type": "string" }, "isDisabled": { "description": "Whether memory item is disabled", "type": "boolean" }, "keywords": { "description": "Set of unique strings used for semantic similarity filtering", "items": { "type": "string" }, "type": "array" }, "modifiedAt": { "description": "Time of the last entity modification.", "example": "2023-07-20 12:30", "format": "date-time", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "strategy": { "description": "Strategy defining when the memory item should be applied", "enum": [ "ALWAYS", "AUTO" ], "type": "string" }, "title": { "maxLength": 255, "nullable": true, "type": "string" } }, "required": [ "instruction", "strategy" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "createdBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "modifiedBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "orgMemoryItem" ], "example": "orgMemoryItem", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiOrgMemoryItemOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiOrgMemoryItemOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiOrgMemoryItemOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiOrgMemoryItemOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiOrgMemoryItemOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiOrgMemoryItemPatch": { "description": "Organization-scoped AI memory item.", "properties": { "attributes": { "properties": { "description": { "maxLength": 10000, "nullable": true, "type": "string" }, "instruction": { "description": "The text that will be injected into the system prompt", "maxLength": 255, "type": "string" }, "isDisabled": { "description": "Whether memory item is disabled", "type": "boolean" }, "keywords": { "description": "Set of unique strings used for semantic similarity filtering", "items": { "type": "string" }, "type": "array" }, "strategy": { "description": "Strategy defining when the memory item should be applied", "enum": [ "ALWAYS", "AUTO" ], "type": "string" }, "title": { "maxLength": 255, "nullable": true, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "orgMemoryItem" ], "example": "orgMemoryItem", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiOrgMemoryItemPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiOrgMemoryItemPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiOrganizationIn": { "description": "JSON:API representation of organization entity.", "properties": { "attributes": { "properties": { "allowedOrigins": { "items": { "type": "string" }, "type": "array" }, "earlyAccess": { "deprecated": true, "description": "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", "maxLength": 255, "nullable": true, "type": "string" }, "earlyAccessValues": { "description": "The early access feature identifiers. They are used to enable experimental features.", "items": { "maxLength": 255, "type": "string" }, "nullable": true, "type": "array" }, "hostname": { "maxLength": 255, "type": "string" }, "name": { "maxLength": 255, "nullable": true, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "identityProvider": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiIdentityProviderToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "organization" ], "example": "organization", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiOrganizationInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiOrganizationIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiOrganizationOut": { "description": "JSON:API representation of organization entity.", "properties": { "attributes": { "properties": { "allowedOrigins": { "items": { "type": "string" }, "type": "array" }, "cacheSettings": { "properties": { "cacheStrategy": { "enum": [ "DURABLE", "EPHEMERAL" ], "maxLength": 255, "type": "string" }, "extraCacheBudget": { "format": "int64", "type": "integer" } }, "type": "object" }, "dataCenter": { "description": "Current deployment region. Should be used for issue investigation only.", "nullable": true, "type": "string" }, "earlyAccess": { "deprecated": true, "description": "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", "maxLength": 255, "nullable": true, "type": "string" }, "earlyAccessValues": { "description": "The early access feature identifiers. They are used to enable experimental features.", "items": { "maxLength": 255, "type": "string" }, "nullable": true, "type": "array" }, "hostname": { "maxLength": 255, "type": "string" }, "name": { "maxLength": 255, "nullable": true, "type": "string" }, "region": { "description": "Current deployment cluster name. Should be used for issue investigation only.", "nullable": true, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "meta": { "properties": { "permissions": { "description": "List of valid permissions for a logged-in user.", "items": { "enum": [ "MANAGE", "SELF_CREATE_TOKEN", "BASE_UI_ACCESS" ], "type": "string" }, "type": "array" } }, "type": "object" }, "relationships": { "properties": { "bootstrapUser": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "bootstrapUserGroup": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "identityProvider": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiIdentityProviderToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "organization" ], "example": "organization", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiOrganizationOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiOrganizationOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiOrganizationOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiOrganizationOutIncludes": { "oneOf": [ { "$ref": "#/components/schemas/JsonApiIdentityProviderOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiUserOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" } ] }, "JsonApiOrganizationPatch": { "description": "JSON:API representation of patching organization entity.", "properties": { "attributes": { "properties": { "allowedOrigins": { "items": { "type": "string" }, "type": "array" }, "earlyAccess": { "deprecated": true, "description": "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", "maxLength": 255, "nullable": true, "type": "string" }, "earlyAccessValues": { "description": "The early access feature identifiers. They are used to enable experimental features.", "items": { "maxLength": 255, "type": "string" }, "nullable": true, "type": "array" }, "hostname": { "maxLength": 255, "type": "string" }, "name": { "maxLength": 255, "nullable": true, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "identityProvider": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiIdentityProviderToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "organization" ], "example": "organization", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiOrganizationPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiOrganizationPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiOrganizationSettingIn": { "description": "JSON:API representation of organizationSetting entity.", "properties": { "attributes": { "properties": { "content": { "description": "Free-form JSON content. Maximum supported length is 15000 characters.", "example": {}, "type": "object" }, "type": { "enum": [ "TIMEZONE", "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", "GEO_ICON_SHEET", "AG_GRID_TOKEN", "WEEK_START", "FISCAL_YEAR", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", "ALERT", "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", "ENABLE_DRILL_TO_URL_BY_DEFAULT", "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", "ENABLE_AUTOMATION_EVALUATION_MODE", "ENABLE_ACCESSIBILITY_MODE", "REGISTERED_PLUGGABLE_APPLICATIONS", "DATA_LOCALE", "LDM_DEFAULT_LOCALE", "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", "CERTIFY_PARENT_OBJECTS", "HLL_TYPE" ], "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "organizationSetting" ], "example": "organizationSetting", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiOrganizationSettingInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiOrganizationSettingIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiOrganizationSettingOut": { "description": "JSON:API representation of organizationSetting entity.", "properties": { "attributes": { "properties": { "content": { "description": "Free-form JSON content. Maximum supported length is 15000 characters.", "example": {}, "type": "object" }, "type": { "enum": [ "TIMEZONE", "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", "GEO_ICON_SHEET", "AG_GRID_TOKEN", "WEEK_START", "FISCAL_YEAR", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", "ALERT", "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", "ENABLE_DRILL_TO_URL_BY_DEFAULT", "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", "ENABLE_AUTOMATION_EVALUATION_MODE", "ENABLE_ACCESSIBILITY_MODE", "REGISTERED_PLUGGABLE_APPLICATIONS", "DATA_LOCALE", "LDM_DEFAULT_LOCALE", "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", "CERTIFY_PARENT_OBJECTS", "HLL_TYPE" ], "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "organizationSetting" ], "example": "organizationSetting", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiOrganizationSettingOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiOrganizationSettingOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiOrganizationSettingOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiOrganizationSettingOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiOrganizationSettingOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiOrganizationSettingOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiOrganizationSettingPatch": { "description": "JSON:API representation of patching organizationSetting entity.", "properties": { "attributes": { "properties": { "content": { "description": "Free-form JSON content. Maximum supported length is 15000 characters.", "example": {}, "type": "object" }, "type": { "enum": [ "TIMEZONE", "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", "GEO_ICON_SHEET", "AG_GRID_TOKEN", "WEEK_START", "FISCAL_YEAR", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", "ALERT", "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", "ENABLE_DRILL_TO_URL_BY_DEFAULT", "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", "ENABLE_AUTOMATION_EVALUATION_MODE", "ENABLE_ACCESSIBILITY_MODE", "REGISTERED_PLUGGABLE_APPLICATIONS", "DATA_LOCALE", "LDM_DEFAULT_LOCALE", "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", "CERTIFY_PARENT_OBJECTS", "HLL_TYPE" ], "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "organizationSetting" ], "example": "organizationSetting", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiOrganizationSettingPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiOrganizationSettingPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiPageInfo": { "description": "Pagination information", "properties": { "number": { "description": "Zero-based page number", "format": "int32", "type": "integer" }, "size": { "description": "Page size", "format": "int32", "type": "integer" }, "totalElements": { "description": "Total number of elements; only present when metaInclude=page was requested", "format": "int32", "type": "integer" }, "totalPages": { "description": "Total number of pages; only present when metaInclude=page was requested", "format": "int32", "type": "integer" } }, "required": [ "number", "size" ], "type": "object" }, "JsonApiParameterIn": { "description": "JSON:API representation of parameter entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "definition": { "discriminator": { "mapping": { "NUMBER": "#/components/schemas/NumberParameterDefinition", "STRING": "#/components/schemas/StringParameterDefinition" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/NumberParameterDefinition" }, { "$ref": "#/components/schemas/StringParameterDefinition" } ], "type": "object" }, "description": { "maxLength": 10000, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "required": [ "definition" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "parameter" ], "example": "parameter", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiParameterInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiParameterIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiParameterLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { "type": "string" }, "type": { "enum": [ "parameter" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiParameterOut": { "description": "JSON:API representation of parameter entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "createdAt": { "description": "Time of the entity creation.", "example": "2023-07-20 12:30", "format": "date-time", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "definition": { "discriminator": { "mapping": { "NUMBER": "#/components/schemas/NumberParameterDefinition", "STRING": "#/components/schemas/StringParameterDefinition" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/NumberParameterDefinition" }, { "$ref": "#/components/schemas/StringParameterDefinition" } ], "type": "object" }, "description": { "maxLength": 10000, "type": "string" }, "modifiedAt": { "description": "Time of the last entity modification.", "example": "2023-07-20 12:30", "format": "date-time", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "required": [ "definition" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "meta": { "properties": { "origin": { "properties": { "originId": { "description": "defines id of the workspace where the entity comes from", "type": "string" }, "originType": { "description": "defines type of the origin of the entity", "enum": [ "NATIVE", "PARENT" ], "type": "string" } }, "required": [ "originId", "originType" ], "type": "object" } }, "type": "object" }, "relationships": { "properties": { "createdBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "modifiedBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "parameter" ], "example": "parameter", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiParameterOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiParameterOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiParameterOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiParameterOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiParameterOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiParameterOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiParameterPatch": { "description": "JSON:API representation of patching parameter entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "definition": { "discriminator": { "mapping": { "NUMBER": "#/components/schemas/NumberParameterDefinition", "STRING": "#/components/schemas/StringParameterDefinition" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/NumberParameterDefinition" }, { "$ref": "#/components/schemas/StringParameterDefinition" } ], "type": "object" }, "description": { "maxLength": 10000, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "parameter" ], "example": "parameter", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiParameterPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiParameterPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiParameterPostOptionalId": { "description": "JSON:API representation of parameter entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "definition": { "discriminator": { "mapping": { "NUMBER": "#/components/schemas/NumberParameterDefinition", "STRING": "#/components/schemas/StringParameterDefinition" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/NumberParameterDefinition" }, { "$ref": "#/components/schemas/StringParameterDefinition" } ], "type": "object" }, "description": { "maxLength": 10000, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "required": [ "definition" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "parameter" ], "example": "parameter", "type": "string" } }, "required": [ "attributes", "type" ], "type": "object" }, "JsonApiParameterPostOptionalIdDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiParameterPostOptionalId" } }, "required": [ "data" ], "type": "object" }, "JsonApiParameterToManyLinkage": { "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "items": { "$ref": "#/components/schemas/JsonApiParameterLinkage" }, "type": "array" }, "JsonApiThemeIn": { "description": "JSON:API representation of theme entity.", "properties": { "attributes": { "properties": { "content": { "description": "Free-form JSON content. Maximum supported length is 15000 characters.", "example": {}, "type": "object" }, "name": { "maxLength": 255, "type": "string" } }, "required": [ "content", "name" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "theme" ], "example": "theme", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiThemeInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiThemeIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiThemeOut": { "description": "JSON:API representation of theme entity.", "properties": { "attributes": { "properties": { "content": { "description": "Free-form JSON content. Maximum supported length is 15000 characters.", "example": {}, "type": "object" }, "name": { "maxLength": 255, "type": "string" } }, "required": [ "content", "name" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "theme" ], "example": "theme", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiThemeOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiThemeOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiThemeOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiThemeOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiThemeOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiThemeOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiThemePatch": { "description": "JSON:API representation of patching theme entity.", "properties": { "attributes": { "properties": { "content": { "description": "Free-form JSON content. Maximum supported length is 15000 characters.", "example": {}, "type": "object" }, "name": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "theme" ], "example": "theme", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiThemePatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiThemePatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiUserDataFilterIn": { "description": "JSON:API representation of userDataFilter entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "description": { "maxLength": 10000, "type": "string" }, "maql": { "maxLength": 10000, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "required": [ "maql" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "user": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "userGroup": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "userDataFilter" ], "example": "userDataFilter", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiUserDataFilterInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserDataFilterIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiUserDataFilterOut": { "description": "JSON:API representation of userDataFilter entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "description": { "maxLength": 10000, "type": "string" }, "maql": { "maxLength": 10000, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "required": [ "maql" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "meta": { "properties": { "origin": { "properties": { "originId": { "description": "defines id of the workspace where the entity comes from", "type": "string" }, "originType": { "description": "defines type of the origin of the entity", "enum": [ "NATIVE", "PARENT" ], "type": "string" } }, "required": [ "originId", "originType" ], "type": "object" } }, "type": "object" }, "relationships": { "properties": { "attributes": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "datasets": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "facts": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiFactToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "labels": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "metrics": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiMetricToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "parameters": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiParameterToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "user": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "userGroup": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "userDataFilter" ], "example": "userDataFilter", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiUserDataFilterOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserDataFilterOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiUserDataFilterOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiUserDataFilterOutIncludes": { "oneOf": [ { "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiFactOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiParameterOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiUserOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" } ] }, "JsonApiUserDataFilterOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiUserDataFilterOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiUserDataFilterOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiUserDataFilterOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiUserDataFilterOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiUserDataFilterPatch": { "description": "JSON:API representation of patching userDataFilter entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "description": { "maxLength": 10000, "type": "string" }, "maql": { "maxLength": 10000, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "user": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "userGroup": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "userDataFilter" ], "example": "userDataFilter", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiUserDataFilterPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserDataFilterPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiUserDataFilterPostOptionalId": { "description": "JSON:API representation of userDataFilter entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "description": { "maxLength": 10000, "type": "string" }, "maql": { "maxLength": 10000, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "required": [ "maql" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "user": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "userGroup": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "userDataFilter" ], "example": "userDataFilter", "type": "string" } }, "required": [ "attributes", "type" ], "type": "object" }, "JsonApiUserDataFilterPostOptionalIdDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserDataFilterPostOptionalId" } }, "required": [ "data" ], "type": "object" }, "JsonApiUserGroupIn": { "description": "JSON:API representation of userGroup entity.", "properties": { "attributes": { "properties": { "name": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "parents": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "userGroup" ], "example": "userGroup", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiUserGroupInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserGroupIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiUserGroupLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { "type": "string" }, "type": { "enum": [ "userGroup" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiUserGroupOut": { "description": "JSON:API representation of userGroup entity.", "properties": { "attributes": { "properties": { "name": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "parents": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "userGroup" ], "example": "userGroup", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiUserGroupOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserGroupOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiUserGroupOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiUserGroupOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiUserGroupOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiUserGroupPatch": { "description": "JSON:API representation of patching userGroup entity.", "properties": { "attributes": { "properties": { "name": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "parents": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "userGroup" ], "example": "userGroup", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiUserGroupPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserGroupPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiUserGroupToManyLinkage": { "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "items": { "$ref": "#/components/schemas/JsonApiUserGroupLinkage" }, "type": "array" }, "JsonApiUserGroupToOneLinkage": { "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonApiUserGroupLinkage" } ] }, "JsonApiUserIdentifierLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { "type": "string" }, "type": { "enum": [ "userIdentifier" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiUserIdentifierOut": { "description": "JSON:API representation of userIdentifier entity.", "properties": { "attributes": { "properties": { "email": { "maxLength": 255, "type": "string" }, "firstname": { "maxLength": 255, "type": "string" }, "lastname": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "userIdentifier" ], "example": "userIdentifier", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiUserIdentifierOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiUserIdentifierOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiUserIdentifierOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiUserIdentifierOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiUserIdentifierToOneLinkage": { "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonApiUserIdentifierLinkage" } ] }, "JsonApiUserIn": { "description": "JSON:API representation of user entity.", "properties": { "attributes": { "properties": { "authenticationId": { "maxLength": 255, "type": "string" }, "email": { "maxLength": 255, "type": "string" }, "firstname": { "maxLength": 255, "type": "string" }, "lastname": { "maxLength": 255, "type": "string" }, "systemAccount": { "description": "Is user system account", "example": false, "type": "boolean" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "userGroups": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "user" ], "example": "user", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiUserInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiUserLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { "type": "string" }, "type": { "enum": [ "user" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiUserOut": { "description": "JSON:API representation of user entity.", "properties": { "attributes": { "properties": { "authenticationId": { "maxLength": 255, "type": "string" }, "email": { "maxLength": 255, "type": "string" }, "firstname": { "maxLength": 255, "type": "string" }, "lastname": { "maxLength": 255, "type": "string" }, "systemAccount": { "description": "Is user system account", "example": false, "type": "boolean" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "userGroups": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "user" ], "example": "user", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiUserOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiUserOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiUserOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiUserOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiUserOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiUserPatch": { "description": "JSON:API representation of patching user entity.", "properties": { "attributes": { "properties": { "authenticationId": { "maxLength": 255, "type": "string" }, "email": { "maxLength": 255, "type": "string" }, "firstname": { "maxLength": 255, "type": "string" }, "lastname": { "maxLength": 255, "type": "string" }, "systemAccount": { "description": "Is user system account", "example": false, "type": "boolean" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "userGroups": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "user" ], "example": "user", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiUserPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiUserSettingIn": { "description": "JSON:API representation of userSetting entity.", "properties": { "attributes": { "properties": { "content": { "description": "Free-form JSON content. Maximum supported length is 15000 characters.", "example": {}, "type": "object" }, "type": { "enum": [ "TIMEZONE", "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", "GEO_ICON_SHEET", "AG_GRID_TOKEN", "WEEK_START", "FISCAL_YEAR", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", "ALERT", "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", "ENABLE_DRILL_TO_URL_BY_DEFAULT", "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", "ENABLE_AUTOMATION_EVALUATION_MODE", "ENABLE_ACCESSIBILITY_MODE", "REGISTERED_PLUGGABLE_APPLICATIONS", "DATA_LOCALE", "LDM_DEFAULT_LOCALE", "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", "CERTIFY_PARENT_OBJECTS", "HLL_TYPE" ], "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "userSetting" ], "example": "userSetting", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiUserSettingInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserSettingIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiUserSettingOut": { "description": "JSON:API representation of userSetting entity.", "properties": { "attributes": { "properties": { "content": { "description": "Free-form JSON content. Maximum supported length is 15000 characters.", "example": {}, "type": "object" }, "type": { "enum": [ "TIMEZONE", "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", "GEO_ICON_SHEET", "AG_GRID_TOKEN", "WEEK_START", "FISCAL_YEAR", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", "ALERT", "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", "ENABLE_DRILL_TO_URL_BY_DEFAULT", "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", "ENABLE_AUTOMATION_EVALUATION_MODE", "ENABLE_ACCESSIBILITY_MODE", "REGISTERED_PLUGGABLE_APPLICATIONS", "DATA_LOCALE", "LDM_DEFAULT_LOCALE", "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", "CERTIFY_PARENT_OBJECTS", "HLL_TYPE" ], "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "userSetting" ], "example": "userSetting", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiUserSettingOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserSettingOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiUserSettingOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiUserSettingOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiUserSettingOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiUserSettingOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiUserToManyLinkage": { "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "items": { "$ref": "#/components/schemas/JsonApiUserLinkage" }, "type": "array" }, "JsonApiUserToOneLinkage": { "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonApiUserLinkage" } ] }, "JsonApiVisualizationObjectIn": { "description": "JSON:API representation of visualizationObject entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "content": { "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": { "identifier": { "id": "label.leaf", "type": "label" }, "someBoolProp": false }, "type": "object" }, "description": { "maxLength": 10000, "type": "string" }, "isHidden": { "type": "boolean" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "required": [ "content" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "visualizationObject" ], "example": "visualizationObject", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiVisualizationObjectInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiVisualizationObjectIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiVisualizationObjectLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { "type": "string" }, "type": { "enum": [ "visualizationObject" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiVisualizationObjectOut": { "description": "JSON:API representation of visualizationObject entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "certification": { "description": "Certification status of the entity.", "enum": [ "CERTIFIED" ], "type": "string" }, "certificationMessage": { "description": "Optional message associated with the certification.", "nullable": true, "type": "string" }, "certifiedAt": { "description": "Time when the certification was set.", "example": "2023-07-20 12:30", "format": "date-time", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "content": { "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": { "identifier": { "id": "label.leaf", "type": "label" }, "someBoolProp": false }, "type": "object" }, "createdAt": { "description": "Time of the entity creation.", "example": "2023-07-20 12:30", "format": "date-time", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "description": { "maxLength": 10000, "type": "string" }, "isHidden": { "type": "boolean" }, "modifiedAt": { "description": "Time of the last entity modification.", "example": "2023-07-20 12:30", "format": "date-time", "nullable": true, "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}", "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "required": [ "content" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "meta": { "properties": { "origin": { "properties": { "originId": { "description": "defines id of the workspace where the entity comes from", "type": "string" }, "originType": { "description": "defines type of the origin of the entity", "enum": [ "NATIVE", "PARENT" ], "type": "string" } }, "required": [ "originId", "originType" ], "type": "object" } }, "type": "object" }, "relationships": { "properties": { "attributes": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAttributeToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "certifiedBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "createdBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "datasets": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiDatasetToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "facts": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiFactToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "labels": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiLabelToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "metrics": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiMetricToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "modifiedBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "parameters": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiParameterToManyLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "visualizationObject" ], "example": "visualizationObject", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiVisualizationObjectOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiVisualizationObjectOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiMetricOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiVisualizationObjectOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiVisualizationObjectOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiMetricOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiVisualizationObjectOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiVisualizationObjectOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiVisualizationObjectPatch": { "description": "JSON:API representation of patching visualizationObject entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "content": { "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": { "identifier": { "id": "label.leaf", "type": "label" }, "someBoolProp": false }, "type": "object" }, "description": { "maxLength": 10000, "type": "string" }, "isHidden": { "type": "boolean" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "visualizationObject" ], "example": "visualizationObject", "type": "string" } }, "required": [ "attributes", "id", "type" ], "type": "object" }, "JsonApiVisualizationObjectPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiVisualizationObjectPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiVisualizationObjectPostOptionalId": { "description": "JSON:API representation of visualizationObject entity.", "properties": { "attributes": { "properties": { "areRelationsValid": { "type": "boolean" }, "content": { "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": { "identifier": { "id": "label.leaf", "type": "label" }, "someBoolProp": false }, "type": "object" }, "description": { "maxLength": 10000, "type": "string" }, "isHidden": { "type": "boolean" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "required": [ "content" ], "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "visualizationObject" ], "example": "visualizationObject", "type": "string" } }, "required": [ "attributes", "type" ], "type": "object" }, "JsonApiVisualizationObjectPostOptionalIdDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiVisualizationObjectPostOptionalId" } }, "required": [ "data" ], "type": "object" }, "JsonApiVisualizationObjectToManyLinkage": { "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "items": { "$ref": "#/components/schemas/JsonApiVisualizationObjectLinkage" }, "type": "array" }, "JsonApiVisualizationObjectToOneLinkage": { "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonApiVisualizationObjectLinkage" } ] }, "JsonApiWorkspaceAutomationOut": { "description": "JSON:API representation of workspaceAutomation entity.", "properties": { "attributes": { "properties": { "alert": { "properties": { "condition": { "$ref": "#/components/schemas/AlertCondition" }, "execution": { "$ref": "#/components/schemas/AlertAfm" }, "interval": { "description": "Date granularity for the interval of ONCE_PER_INTERVAL trigger. Supported granularities: DAY, WEEK, MONTH, QUARTER, YEAR.", "enum": [ "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ], "type": "string" }, "trigger": { "default": "ALWAYS", "description": "Trigger behavior for the alert.\nALWAYS - alert is triggered every time the condition is met.\nONCE - alert is triggered only once when the condition is met.\nONCE_PER_INTERVAL - alert is triggered when the condition is met, then suppressed for the interval. If no interval is specified, it behaves as ALWAYS.\n", "enum": [ "ALWAYS", "ONCE", "ONCE_PER_INTERVAL" ], "type": "string" } }, "required": [ "condition", "execution" ], "type": "object" }, "areRelationsValid": { "type": "boolean" }, "createdAt": { "format": "date-time", "type": "string" }, "dashboardTabularExports": { "items": { "properties": { "requestPayload": { "$ref": "#/components/schemas/DashboardTabularExportRequestV2" } }, "required": [ "requestPayload" ], "type": "object" }, "type": "array" }, "description": { "maxLength": 10000, "type": "string" }, "details": { "description": "Additional details to be included in the automated message.", "maxLength": 10000, "type": "object" }, "evaluationMode": { "description": "Specify automation evaluation mode.", "enum": [ "SHARED", "PER_RECIPIENT" ], "type": "string" }, "externalRecipients": { "description": "External recipients of the automation action results.", "items": { "properties": { "email": { "description": "E-mail address to send notifications from.", "format": "email", "type": "string" } }, "required": [ "email" ], "type": "object" }, "type": "array" }, "imageExports": { "items": { "properties": { "requestPayload": { "$ref": "#/components/schemas/ImageExportRequest" } }, "required": [ "requestPayload" ], "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": true, "description": "Additional information for the automation.", "maxLength": 250000, "nullable": true, "properties": { "visibleFilters": { "items": { "$ref": "#/components/schemas/VisibleFilter" }, "type": "array" }, "widget": { "type": "string" } }, "type": "object" }, "modifiedAt": { "format": "date-time", "type": "string" }, "rawExports": { "items": { "properties": { "requestPayload": { "$ref": "#/components/schemas/RawExportAutomationRequest" } }, "required": [ "requestPayload" ], "type": "object" }, "type": "array" }, "schedule": { "properties": { "cron": { "description": "Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.", "example": "0 */30 9-17 ? * MON-FRI", "maxLength": 255, "type": "string" }, "cronDescription": { "description": "Human-readable description of the cron expression.", "readOnly": true, "type": "string" }, "firstRun": { "description": "Timestamp of the first scheduled action. If not provided default to the next scheduled time.", "example": "2025-01-01T12:00:00Z", "format": "date-time", "type": "string" }, "timezone": { "description": "Timezone in which the schedule is defined.", "example": "Europe/Prague", "maxLength": 255, "type": "string" } }, "required": [ "cron", "timezone" ], "type": "object" }, "slidesExports": { "items": { "properties": { "requestPayload": { "$ref": "#/components/schemas/SlidesExportRequest" } }, "required": [ "requestPayload" ], "type": "object" }, "type": "array" }, "state": { "description": "Current state of the automation.", "enum": [ "ACTIVE", "PAUSED" ], "type": "string" }, "tabularExports": { "items": { "properties": { "requestPayload": { "$ref": "#/components/schemas/TabularExportRequest" } }, "required": [ "requestPayload" ], "type": "object" }, "type": "array" }, "tags": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" }, "visualExports": { "items": { "properties": { "requestPayload": { "$ref": "#/components/schemas/VisualExportRequest" } }, "required": [ "requestPayload" ], "type": "object" }, "type": "array" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "analyticalDashboard": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "automationResults": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiAutomationResultToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "createdBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "exportDefinitions": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiExportDefinitionToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "modifiedBy": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserIdentifierToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "notificationChannel": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiNotificationChannelToOneLinkage" } }, "required": [ "data" ], "type": "object" }, "recipients": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiUserToManyLinkage" } }, "required": [ "data" ], "type": "object" }, "workspace": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "workspaceAutomation" ], "example": "workspaceAutomation", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiWorkspaceAutomationOutIncludes": { "oneOf": [ { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiAutomationResultOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiExportDefinitionOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiNotificationChannelOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiUserOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" }, { "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" } ] }, "JsonApiWorkspaceAutomationOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutIncludes" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiWorkspaceAutomationOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiWorkspaceDataFilterIn": { "description": "JSON:API representation of workspaceDataFilter entity.", "properties": { "attributes": { "properties": { "columnName": { "maxLength": 255, "type": "string" }, "description": { "maxLength": 10000, "type": "string" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "filterSettings": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "workspaceDataFilter" ], "example": "workspaceDataFilter", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiWorkspaceDataFilterInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiWorkspaceDataFilterLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { "type": "string" }, "type": { "enum": [ "workspaceDataFilter" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiWorkspaceDataFilterOut": { "description": "JSON:API representation of workspaceDataFilter entity.", "properties": { "attributes": { "properties": { "columnName": { "maxLength": 255, "type": "string" }, "description": { "maxLength": 10000, "type": "string" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "meta": { "properties": { "origin": { "properties": { "originId": { "description": "defines id of the workspace where the entity comes from", "type": "string" }, "originType": { "description": "defines type of the origin of the entity", "enum": [ "NATIVE", "PARENT" ], "type": "string" } }, "required": [ "originId", "originType" ], "type": "object" } }, "type": "object" }, "relationships": { "properties": { "filterSettings": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "workspaceDataFilter" ], "example": "workspaceDataFilter", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiWorkspaceDataFilterOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiWorkspaceDataFilterOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiWorkspaceDataFilterOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiWorkspaceDataFilterPatch": { "description": "JSON:API representation of patching workspaceDataFilter entity.", "properties": { "attributes": { "properties": { "columnName": { "maxLength": 255, "type": "string" }, "description": { "maxLength": 10000, "type": "string" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "filterSettings": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingToManyLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "workspaceDataFilter" ], "example": "workspaceDataFilter", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiWorkspaceDataFilterPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiWorkspaceDataFilterSettingIn": { "description": "JSON:API representation of workspaceDataFilterSetting entity.", "properties": { "attributes": { "properties": { "description": { "maxLength": 10000, "type": "string" }, "filterValues": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "workspaceDataFilter": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "workspaceDataFilterSetting" ], "example": "workspaceDataFilterSetting", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiWorkspaceDataFilterSettingInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiWorkspaceDataFilterSettingLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { "type": "string" }, "type": { "enum": [ "workspaceDataFilterSetting" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiWorkspaceDataFilterSettingOut": { "description": "JSON:API representation of workspaceDataFilterSetting entity.", "properties": { "attributes": { "properties": { "description": { "maxLength": 10000, "type": "string" }, "filterValues": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "meta": { "properties": { "origin": { "properties": { "originId": { "description": "defines id of the workspace where the entity comes from", "type": "string" }, "originType": { "description": "defines type of the origin of the entity", "enum": [ "NATIVE", "PARENT" ], "type": "string" } }, "required": [ "originId", "originType" ], "type": "object" } }, "type": "object" }, "relationships": { "properties": { "workspaceDataFilter": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "workspaceDataFilterSetting" ], "example": "workspaceDataFilterSetting", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiWorkspaceDataFilterSettingOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiWorkspaceDataFilterSettingOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiWorkspaceDataFilterSettingOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiWorkspaceDataFilterSettingPatch": { "description": "JSON:API representation of patching workspaceDataFilterSetting entity.", "properties": { "attributes": { "properties": { "description": { "maxLength": 10000, "type": "string" }, "filterValues": { "items": { "type": "string" }, "type": "array" }, "title": { "maxLength": 255, "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "workspaceDataFilter": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "workspaceDataFilterSetting" ], "example": "workspaceDataFilterSetting", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiWorkspaceDataFilterSettingPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiWorkspaceDataFilterSettingToManyLinkage": { "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "items": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingLinkage" }, "type": "array" }, "JsonApiWorkspaceDataFilterToManyLinkage": { "description": "References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "items": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterLinkage" }, "type": "array" }, "JsonApiWorkspaceDataFilterToOneLinkage": { "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterLinkage" } ] }, "JsonApiWorkspaceIn": { "description": "JSON:API representation of workspace entity.", "properties": { "attributes": { "properties": { "cacheExtraLimit": { "format": "int64", "type": "integer" }, "dataSource": { "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", "properties": { "id": { "description": "The ID of the used data source.", "example": "snowflake.instance.1", "type": "string" }, "schemaPath": { "description": "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", "items": { "description": "The part of the schema path.", "example": "subPath", "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "description": { "maxLength": 255, "nullable": true, "type": "string" }, "earlyAccess": { "deprecated": true, "description": "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", "maxLength": 255, "nullable": true, "type": "string" }, "earlyAccessValues": { "description": "The early access feature identifiers. They are used to enable experimental features.", "items": { "maxLength": 255, "type": "string" }, "nullable": true, "type": "array" }, "name": { "maxLength": 255, "nullable": true, "type": "string" }, "prefix": { "description": "Custom prefix of entity identifiers in workspace", "maxLength": 255, "nullable": true, "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "parent": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "workspace" ], "example": "workspace", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiWorkspaceInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiWorkspaceIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiWorkspaceLinkage": { "description": "The \\\"type\\\" and \\\"id\\\" to non-empty members.", "properties": { "id": { "type": "string" }, "type": { "enum": [ "workspace" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiWorkspaceOut": { "description": "JSON:API representation of workspace entity.", "properties": { "attributes": { "properties": { "cacheExtraLimit": { "format": "int64", "type": "integer" }, "dataSource": { "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", "properties": { "id": { "description": "The ID of the used data source.", "example": "snowflake.instance.1", "type": "string" }, "schemaPath": { "description": "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", "items": { "description": "The part of the schema path.", "example": "subPath", "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "description": { "maxLength": 255, "nullable": true, "type": "string" }, "earlyAccess": { "deprecated": true, "description": "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", "maxLength": 255, "nullable": true, "type": "string" }, "earlyAccessValues": { "description": "The early access feature identifiers. They are used to enable experimental features.", "items": { "maxLength": 255, "type": "string" }, "nullable": true, "type": "array" }, "managed": { "description": "Whether the object is platform-managed and read-only.", "type": "boolean" }, "name": { "maxLength": 255, "nullable": true, "type": "string" }, "prefix": { "description": "Custom prefix of entity identifiers in workspace", "maxLength": 255, "nullable": true, "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "meta": { "properties": { "config": { "properties": { "approximateCountAvailable": { "default": false, "description": "is approximate count enabled - based on type of data-source connected to this workspace", "type": "boolean" }, "dataSamplingAvailable": { "default": false, "description": "is sampling enabled - based on type of data-source connected to this workspace", "type": "boolean" }, "showAllValuesOnDatesAvailable": { "default": false, "description": "is 'show all values' displayed for dates - based on type of data-source connected to this workspace", "type": "boolean" } }, "type": "object" }, "dataModel": { "properties": { "datasetCount": { "description": "include the number of dataset of each workspace", "format": "int32", "type": "integer" } }, "required": [ "datasetCount" ], "type": "object" }, "hierarchy": { "properties": { "childrenCount": { "description": "include the number of direct children of each workspace", "format": "int32", "type": "integer" } }, "required": [ "childrenCount" ], "type": "object" }, "permissions": { "description": "List of valid permissions for a logged-in user.", "items": { "enum": [ "MANAGE", "ANALYZE", "EXPORT", "EXPORT_TABULAR", "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", "WRITE_KNOWLEDGE_DOCUMENTS", "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "VIEW" ], "type": "string" }, "type": "array" } }, "type": "object" }, "relationships": { "properties": { "parent": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "workspace" ], "example": "workspace", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiWorkspaceOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiWorkspaceOut" }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiWorkspaceOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" }, "type": "array", "uniqueItems": true }, "included": { "description": "Included resources", "items": { "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiWorkspaceOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiWorkspaceOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiWorkspacePatch": { "description": "JSON:API representation of patching workspace entity.", "properties": { "attributes": { "properties": { "cacheExtraLimit": { "format": "int64", "type": "integer" }, "dataSource": { "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", "properties": { "id": { "description": "The ID of the used data source.", "example": "snowflake.instance.1", "type": "string" }, "schemaPath": { "description": "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", "items": { "description": "The part of the schema path.", "example": "subPath", "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "description": { "maxLength": 255, "nullable": true, "type": "string" }, "earlyAccess": { "deprecated": true, "description": "The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.", "maxLength": 255, "nullable": true, "type": "string" }, "earlyAccessValues": { "description": "The early access feature identifiers. They are used to enable experimental features.", "items": { "maxLength": 255, "type": "string" }, "nullable": true, "type": "array" }, "name": { "maxLength": 255, "nullable": true, "type": "string" }, "prefix": { "description": "Custom prefix of entity identifiers in workspace", "maxLength": 255, "nullable": true, "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "relationships": { "properties": { "parent": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" } }, "required": [ "data" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "workspace" ], "example": "workspace", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiWorkspacePatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiWorkspacePatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiWorkspaceSettingIn": { "description": "JSON:API representation of workspaceSetting entity.", "properties": { "attributes": { "properties": { "content": { "description": "Free-form JSON content. Maximum supported length is 15000 characters.", "example": {}, "type": "object" }, "type": { "enum": [ "TIMEZONE", "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", "GEO_ICON_SHEET", "AG_GRID_TOKEN", "WEEK_START", "FISCAL_YEAR", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", "ALERT", "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", "ENABLE_DRILL_TO_URL_BY_DEFAULT", "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", "ENABLE_AUTOMATION_EVALUATION_MODE", "ENABLE_ACCESSIBILITY_MODE", "REGISTERED_PLUGGABLE_APPLICATIONS", "DATA_LOCALE", "LDM_DEFAULT_LOCALE", "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", "CERTIFY_PARENT_OBJECTS", "HLL_TYPE" ], "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "workspaceSetting" ], "example": "workspaceSetting", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiWorkspaceSettingInDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiWorkspaceSettingIn" } }, "required": [ "data" ], "type": "object" }, "JsonApiWorkspaceSettingOut": { "description": "JSON:API representation of workspaceSetting entity.", "properties": { "attributes": { "properties": { "content": { "description": "Free-form JSON content. Maximum supported length is 15000 characters.", "example": {}, "type": "object" }, "type": { "enum": [ "TIMEZONE", "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", "GEO_ICON_SHEET", "AG_GRID_TOKEN", "WEEK_START", "FISCAL_YEAR", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", "ALERT", "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", "ENABLE_DRILL_TO_URL_BY_DEFAULT", "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", "ENABLE_AUTOMATION_EVALUATION_MODE", "ENABLE_ACCESSIBILITY_MODE", "REGISTERED_PLUGGABLE_APPLICATIONS", "DATA_LOCALE", "LDM_DEFAULT_LOCALE", "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", "CERTIFY_PARENT_OBJECTS", "HLL_TYPE" ], "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "meta": { "properties": { "origin": { "properties": { "originId": { "description": "defines id of the workspace where the entity comes from", "type": "string" }, "originType": { "description": "defines type of the origin of the entity", "enum": [ "NATIVE", "PARENT" ], "type": "string" } }, "required": [ "originId", "originType" ], "type": "object" } }, "type": "object" }, "type": { "description": "Object type", "enum": [ "workspaceSetting" ], "example": "workspaceSetting", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiWorkspaceSettingOutDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiWorkspaceSettingOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ], "type": "object" }, "JsonApiWorkspaceSettingOutList": { "description": "A JSON:API document with a list of resources", "properties": { "data": { "items": { "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutWithLinks" }, "type": "array", "uniqueItems": true }, "links": { "$ref": "#/components/schemas/ListLinks" }, "meta": { "properties": { "page": { "$ref": "#/components/schemas/PageMetadata" } }, "type": "object" } }, "required": [ "data" ], "type": "object" }, "JsonApiWorkspaceSettingOutWithLinks": { "allOf": [ { "$ref": "#/components/schemas/JsonApiWorkspaceSettingOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, "JsonApiWorkspaceSettingPatch": { "description": "JSON:API representation of patching workspaceSetting entity.", "properties": { "attributes": { "properties": { "content": { "description": "Free-form JSON content. Maximum supported length is 15000 characters.", "example": {}, "type": "object" }, "type": { "enum": [ "TIMEZONE", "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", "GEO_ICON_SHEET", "AG_GRID_TOKEN", "WEEK_START", "FISCAL_YEAR", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", "ALERT", "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", "ENABLE_DRILL_TO_URL_BY_DEFAULT", "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", "ENABLE_AUTOMATION_EVALUATION_MODE", "ENABLE_ACCESSIBILITY_MODE", "REGISTERED_PLUGGABLE_APPLICATIONS", "DATA_LOCALE", "LDM_DEFAULT_LOCALE", "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", "CERTIFY_PARENT_OBJECTS", "HLL_TYPE" ], "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "workspaceSetting" ], "example": "workspaceSetting", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "JsonApiWorkspaceSettingPatchDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiWorkspaceSettingPatch" } }, "required": [ "data" ], "type": "object" }, "JsonApiWorkspaceSettingPostOptionalId": { "description": "JSON:API representation of workspaceSetting entity.", "properties": { "attributes": { "properties": { "content": { "description": "Free-form JSON content. Maximum supported length is 15000 characters.", "example": {}, "type": "object" }, "type": { "enum": [ "TIMEZONE", "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", "GEO_ICON_SHEET", "AG_GRID_TOKEN", "WEEK_START", "FISCAL_YEAR", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", "ALERT", "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", "ENABLE_DRILL_TO_URL_BY_DEFAULT", "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", "ENABLE_AUTOMATION_EVALUATION_MODE", "ENABLE_ACCESSIBILITY_MODE", "REGISTERED_PLUGGABLE_APPLICATIONS", "DATA_LOCALE", "LDM_DEFAULT_LOCALE", "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", "CERTIFY_PARENT_OBJECTS", "HLL_TYPE" ], "type": "string" } }, "type": "object" }, "id": { "description": "API identifier of an object", "example": "id1", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "Object type", "enum": [ "workspaceSetting" ], "example": "workspaceSetting", "type": "string" } }, "required": [ "type" ], "type": "object" }, "JsonApiWorkspaceSettingPostOptionalIdDocument": { "properties": { "data": { "$ref": "#/components/schemas/JsonApiWorkspaceSettingPostOptionalId" } }, "required": [ "data" ], "type": "object" }, "JsonApiWorkspaceToOneLinkage": { "description": "References to other resource objects in a to-one (\\\"relationship\\\"). Relationships can be specified by including a member in a resource's links object.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonApiWorkspaceLinkage" } ] }, "JsonNode": { "description": "Free-form JSON object", "example": {}, "maxLength": 15000, "nullable": true, "type": "object" }, "KeyConfig": { "description": "Key configuration for the table data model.", "discriminator": { "mapping": { "aggregate": "#/components/schemas/AggregateKeyConfig", "duplicate": "#/components/schemas/DuplicateKeyConfig", "primary": "#/components/schemas/PrimaryKeyConfig", "unique": "#/components/schemas/UniqueKeyConfig" }, "propertyName": "type" }, "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "KeyDriverAnalysis": { "additionalProperties": false, "properties": { "analyzedPeriod": { "description": "Analyzed period identifier.", "title": "Analyzedperiod", "type": "string" }, "dateAttributeId": { "description": "Date attribute identifier used for period comparison.", "title": "Dateattributeid", "type": "string" }, "filters": { "description": "Filters applied to analysis.", "items": { "additionalProperties": true, "type": "object" }, "title": "Filters", "type": "array" }, "measure": { "$ref": "#/components/schemas/KeyDriverAnalysisMeasure", "description": "Measure definition for key driver analysis." }, "referencePeriod": { "description": "Reference period identifier.", "title": "Referenceperiod", "type": "string" } }, "required": [ "measure", "dateAttributeId", "analyzedPeriod", "referencePeriod", "filters" ], "title": "KeyDriverAnalysis", "type": "object" }, "KeyDriverAnalysisMeasure": { "additionalProperties": false, "properties": { "aggregation": { "anyOf": [ { "enum": [ "SUM", "AVG", "MIN", "MAX", "MEDIAN", "COUNT" ], "type": "string" }, { "type": "null" } ], "description": "Optional aggregation function.", "title": "Aggregation" }, "id": { "description": "Measure object identifier.", "title": "Id", "type": "string" }, "type": { "description": "Measure object type.", "enum": [ "metric", "fact", "attribute" ], "title": "Type", "type": "string" } }, "required": [ "id", "type" ], "title": "KeyDriverAnalysisMeasure", "type": "object" }, "KeyDriverAnalysisPart": { "additionalProperties": false, "properties": { "kda": { "anyOf": [ { "$ref": "#/components/schemas/KeyDriverAnalysis" }, { "type": "null" } ], "description": "Optional full key driver analysis payload when available." }, "type": { "const": "kda", "default": "kda", "description": "Type of multipart part.", "title": "Type", "type": "string" } }, "title": "KeyDriverAnalysisPart", "type": "object" }, "KeyDriversDimension": { "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_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR" ], "type": "string" }, "label": { "$ref": "#/components/schemas/RestApiIdentifier" }, "labelName": { "type": "string" }, "valueType": { "enum": [ "TEXT", "HYPERLINK", "GEO", "GEO_LONGITUDE", "GEO_LATITUDE", "GEO_AREA", "GEO_ICON", "IMAGE", "HYPERLOGLOG" ], "type": "string" } }, "required": [ "attribute", "attributeName", "label", "labelName" ], "type": "object" }, "KeyDriversRequest": { "properties": { "auxMetrics": { "description": "Additional metrics to be included in the computation, but excluded from the analysis.", "items": { "$ref": "#/components/schemas/MeasureItem" }, "type": "array" }, "metric": { "$ref": "#/components/schemas/MeasureItem" }, "sortDirection": { "default": "DESC", "description": "Sorting elements - ascending/descending order.", "enum": [ "ASC", "DESC" ], "type": "string" } }, "required": [ "metric" ], "type": "object" }, "KeyDriversResponse": { "properties": { "dimensions": { "items": { "$ref": "#/components/schemas/KeyDriversDimension" }, "type": "array" }, "links": { "$ref": "#/components/schemas/ExecutionLinks" } }, "required": [ "dimensions", "links" ], "type": "object" }, "KeyDriversResult": { "properties": { "data": { "type": "object" } }, "required": [ "data" ], "type": "object" }, "LabelIdentifier": { "description": "A label identifier.", "properties": { "id": { "description": "Label ID.", "example": "label_id", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "A type of the label.", "enum": [ "label" ], "example": "label", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "LdmObjectPermissions": { "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" }, "LdmObjectPermissionsAssignment": { "description": "Desired levels of permissions on an LDM object (attribute, label, fact) for an assignee.", "properties": { "permissions": { "items": { "enum": [ "EDIT", "SHARE", "VIEW" ], "type": "string" }, "type": "array" } }, "required": [ "permissions" ], "type": "object" }, "LdmObjectPermissionsForAssignee": { "allOf": [ { "$ref": "#/components/schemas/LdmObjectPermissionsAssignment" }, { "properties": { "assigneeIdentifier": { "$ref": "#/components/schemas/AssigneeIdentifier" } }, "type": "object" } ], "description": "Desired levels of LDM-object permissions for an assignee identified by an identifier.", "required": [ "assigneeIdentifier", "permissions" ], "type": "object" }, "LdmObjectPermissionsForAssigneeRule": { "allOf": [ { "$ref": "#/components/schemas/LdmObjectPermissionsAssignment" }, { "properties": { "assigneeRule": { "$ref": "#/components/schemas/AssigneeRule" } }, "type": "object" } ], "description": "Desired levels of LDM-object permissions for a collection of assignees identified by a rule.", "required": [ "assigneeRule", "permissions" ], "type": "object" }, "ListLinks": { "allOf": [ { "$ref": "#/components/schemas/ObjectLinks" }, { "properties": { "next": { "description": "A string containing the link's URL for the next page of data.", "format": "uri", "type": "string" } }, "type": "object" } ] }, "ListLlmProviderModelsRequest": { "properties": { "providerConfig": { "oneOf": [ { "$ref": "#/components/schemas/AnthropicProviderConfig" }, { "$ref": "#/components/schemas/AwsBedrockProviderConfig" }, { "$ref": "#/components/schemas/AzureFoundryProviderConfig" }, { "$ref": "#/components/schemas/OpenAIProviderConfig" } ] } }, "required": [ "providerConfig" ], "type": "object" }, "ListLlmProviderModelsResponse": { "properties": { "message": { "description": "Message about the listing result.", "type": "string" }, "models": { "description": "Available models on the provider.", "items": { "$ref": "#/components/schemas/LlmModel" }, "type": "array" }, "success": { "description": "Whether the model listing succeeded.", "type": "boolean" } }, "required": [ "message", "models", "success" ], "type": "object" }, "LiveFeatureFlagConfiguration": { "properties": { "host": { "type": "string" }, "key": { "type": "string" } }, "required": [ "host", "key" ], "type": "object" }, "LiveFeatures": { "description": "Structure for featureHub", "properties": { "live": { "allOf": [ { "$ref": "#/components/schemas/Features" }, { "properties": { "configuration": { "$ref": "#/components/schemas/LiveFeatureFlagConfiguration" } }, "type": "object" } ], "required": [ "configuration", "context" ], "type": "object" } }, "required": [ "live" ], "type": "object" }, "LlmModel": { "description": "LLM Model configuration (id, family) within a provider.", "properties": { "family": { "description": "Family of LLM models.", "enum": [ "OPENAI", "ANTHROPIC", "META", "MISTRAL", "AMAZON", "GOOGLE", "COHERE", "UNKNOWN" ], "type": "string" }, "id": { "description": "Unique identifier of the model (e.g., gpt-5.3, claude-4.6).", "maxLength": 255, "type": "string" } }, "required": [ "family", "id" ], "type": "object" }, "LlmProviderAuth": { "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "LlmProviderConfig": { "description": "Provider configuration overrides.", "oneOf": [ { "$ref": "#/components/schemas/AnthropicProviderConfig" }, { "$ref": "#/components/schemas/AwsBedrockProviderConfig" }, { "$ref": "#/components/schemas/AzureFoundryProviderConfig" }, { "$ref": "#/components/schemas/OpenAIProviderConfig" } ] }, "LocalIdentifier": { "properties": { "format": { "default": "#,##0.00", "description": "Metric format.", "example": "#,##0", "maxLength": 2048, "nullable": true, "type": "string" }, "localIdentifier": { "description": "Local identifier of the metric to be compared.", "example": "m1", "type": "string" }, "title": { "description": "Metric title.", "example": "Revenue", "maxLength": 255, "nullable": true, "type": "string" } }, "required": [ "localIdentifier" ], "type": "object" }, "LocaleRequest": { "properties": { "locale": { "description": "Requested locale in the form of language tag (see RFC 5646).", "example": "en-US", "type": "string" } }, "required": [ "locale" ], "type": "object" }, "MatchAttributeFilter": { "additionalProperties": false, "description": "Filter via label with given match type and literal value.", "properties": { "matchAttributeFilter": { "$ref": "#/components/schemas/MatchAttributeFilterBody", "properties": { "applyOnResult": { "type": "boolean" }, "caseSensitive": { "default": false, "description": "Indicates whether the filter match is evaluated in case-sensitive mode or not.", "type": "boolean" }, "label": { "$ref": "#/components/schemas/AfmIdentifier" }, "literal": { "description": "Literal used to limit label values.", "example": "value", "type": "string" }, "localIdentifier": { "type": "string" }, "matchType": { "description": "Requested match type.", "enum": [ "STARTS_WITH", "ENDS_WITH", "CONTAINS" ], "type": "string" }, "negate": { "default": false, "description": "Indicates whether the filter should negate the match.", "type": "boolean" } }, "required": [ "label", "literal", "matchType" ], "type": "object" } }, "required": [ "matchAttributeFilter" ], "title": "MatchAttributeFilter", "type": "object" }, "MatchAttributeFilterBody": { "additionalProperties": false, "properties": { "applyOnResult": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Applyonresult" }, "caseSensitive": { "default": false, "title": "Casesensitive", "type": "boolean" }, "label": { "anyOf": [ { "$ref": "#/components/schemas/AfmObjectIdentifier" }, { "$ref": "#/components/schemas/AfmLocalIdentifier" } ], "title": "Label" }, "literal": { "title": "Literal", "type": "string" }, "localIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Localidentifier" }, "matchType": { "$ref": "#/components/schemas/MatchType" }, "negate": { "default": false, "title": "Negate", "type": "boolean" } }, "required": [ "label", "literal", "matchType" ], "title": "MatchAttributeFilterBody", "type": "object" }, "MatchType": { "enum": [ "STARTS_WITH", "ENDS_WITH", "CONTAINS" ], "title": "MatchType", "type": "string" }, "MatomoService": { "description": "Matomo service.", "properties": { "host": { "description": "Telemetry host to send events to.", "type": "string" }, "reportingEndpoint": { "description": "Optional reporting endpoint for proxying telemetry events.", "type": "string" }, "siteId": { "description": "Site ID on telemetry server.", "format": "int32", "type": "integer" } }, "required": [ "host", "siteId" ], "type": "object" }, "MeasureDefinition": { "description": "Abstract metric definition type", "oneOf": [ { "$ref": "#/components/schemas/InlineMeasureDefinition" }, { "$ref": "#/components/schemas/ArithmeticMeasureDefinition" }, { "$ref": "#/components/schemas/SimpleMeasureDefinition" }, { "$ref": "#/components/schemas/PopMeasureDefinition" } ], "type": "object" }, "MeasureExecutionResultHeader": { "properties": { "measureHeader": { "$ref": "#/components/schemas/MeasureResultHeader" } }, "required": [ "measureHeader" ], "type": "object" }, "MeasureGroupHeaders": { "description": "Measure group headers", "properties": { "measureGroupHeaders": { "items": { "$ref": "#/components/schemas/MeasureHeader" }, "type": "array" } }, "type": "object" }, "MeasureHeader": { "properties": { "format": { "description": "Format to be used to format the measure data.", "type": "string" }, "localIdentifier": { "description": "Local identifier of the measure this header relates to.", "type": "string" }, "name": { "description": "Name of the measure.", "type": "string" } }, "required": [ "localIdentifier" ], "type": "object" }, "MeasureItem": { "description": "Metric is a quantity that is calculated from the data.", "properties": { "definition": { "$ref": "#/components/schemas/MeasureDefinition", "oneOf": [ { "$ref": "#/components/schemas/ArithmeticMeasureDefinition" }, { "$ref": "#/components/schemas/InlineMeasureDefinition" }, { "$ref": "#/components/schemas/PopDatasetMeasureDefinition" }, { "$ref": "#/components/schemas/PopDateMeasureDefinition" }, { "$ref": "#/components/schemas/PopMeasureDefinition" }, { "$ref": "#/components/schemas/SimpleMeasureDefinition" } ] }, "localIdentifier": { "description": "Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.", "example": "metric_1", "pattern": "^[.a-zA-Z0-9_-]+$", "type": "string" } }, "required": [ "definition", "localIdentifier" ], "type": "object" }, "MeasureResultHeader": { "description": "Header containing the information related to metrics.", "properties": { "measureIndex": { "description": "Metric index. Starts at 0.", "example": 0, "format": "int32", "type": "integer" } }, "required": [ "measureIndex" ], "type": "object" }, "MeasureValueComparisonCondition": { "additionalProperties": false, "description": "Comparison branch of a compound measure value condition: ``{\"comparison\": {...}}``.", "properties": { "comparison": { "$ref": "#/components/schemas/_MeasureValueComparisonInner" } }, "required": [ "comparison" ], "title": "MeasureValueComparisonCondition", "type": "object" }, "MeasureValueCondition": { "description": "A condition for filtering by measure value. Can be either a comparison or a range condition.", "oneOf": [ { "$ref": "#/components/schemas/ComparisonCondition" }, { "$ref": "#/components/schemas/RangeCondition" } ], "type": "object" }, "MeasureValueFilter": { "description": "Abstract filter definition type filtering by the value of the metric.", "oneOf": [ { "$ref": "#/components/schemas/ComparisonMeasureValueFilter" }, { "$ref": "#/components/schemas/RangeMeasureValueFilter" }, { "$ref": "#/components/schemas/CompoundMeasureValueFilter" } ], "type": "object" }, "MeasureValueRangeCondition": { "additionalProperties": false, "description": "Range branch of a compound measure value condition: ``{\"range\": {...}}``.", "properties": { "range": { "$ref": "#/components/schemas/_MeasureValueRangeInner" } }, "required": [ "range" ], "title": "MeasureValueRangeCondition", "type": "object" }, "MemoryItemCreatedByUsers": { "properties": { "reasoning": { "description": "Reasoning for error states", "type": "string" }, "users": { "description": "Users who created memory item", "items": { "$ref": "#/components/schemas/MemoryItemUser" }, "type": "array" } }, "required": [ "reasoning", "users" ], "type": "object" }, "MemoryItemUser": { "description": "Users who created memory item", "properties": { "firstname": { "description": "First name of the user who created memory item", "type": "string" }, "lastname": { "description": "Last name of the user who created memory item", "type": "string" }, "userId": { "description": "User ID of the user who created memory item", "type": "string" } }, "required": [ "firstname", "lastname", "userId" ], "type": "object" }, "Metric": { "description": "List of metrics to be used in the new visualization", "properties": { "aggFunction": { "description": "Agg function. Empty if a stored metric is used.", "enum": [ "COUNT", "SUM", "MIN", "MAX", "AVG", "MEDIAN" ], "type": "string" }, "id": { "description": "ID of the object", "example": "revenue", "type": "string" }, "title": { "description": "Title of metric.", "type": "string" }, "type": { "description": "Object type", "enum": [ "metric", "fact", "attribute" ], "example": "metric", "type": "string" } }, "required": [ "id", "title", "type" ], "type": "object" }, "MetricDefinitionOverride": { "description": "(EXPERIMENTAL) Override for a catalog metric definition.", "properties": { "definition": { "$ref": "#/components/schemas/InlineMeasureDefinition" }, "item": { "$ref": "#/components/schemas/AfmObjectIdentifierCore" } }, "required": [ "definition", "item" ], "type": "object" }, "MetricOperand": { "additionalProperties": false, "description": "Reference to a metric by AFM local identifier.", "properties": { "format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Metric display format.", "title": "Format" }, "localIdentifier": { "description": "Local identifier of the metric to be compared.", "title": "Localidentifier", "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Metric display title.", "title": "Title" } }, "required": [ "localIdentifier" ], "title": "MetricOperand", "type": "object" }, "MetricRecord": { "properties": { "formattedValue": { "type": "string" }, "value": { "format": "double", "type": "number" } }, "required": [ "value" ], "type": "object" }, "MetricSortItem": { "additionalProperties": false, "properties": { "direction": { "enum": [ "ASC", "DESC" ], "title": "Direction", "type": "string" }, "metrics": { "items": { "anyOf": [ { "type": "string" }, { "$ref": "#/components/schemas/MetricSortLocatorItem" } ] }, "title": "Metrics", "type": "array" }, "type": { "const": "metric_sort", "title": "Type", "type": "string" } }, "required": [ "type", "direction", "metrics" ], "title": "MetricSortItem", "type": "object" }, "MetricSortLocatorItem": { "additionalProperties": false, "properties": { "by": { "title": "By", "type": "string" }, "element": { "title": "Element", "type": "string" }, "function": { "title": "Function", "type": "string" } }, "required": [ "by" ], "title": "MetricSortLocatorItem", "type": "object" }, "MetricUsageResponse": { "properties": { "currentValue": { "title": "Currentvalue", "type": "integer" }, "previousValue": { "title": "Previousvalue", "type": "integer" }, "total": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Total" }, "type": { "$ref": "#/components/schemas/ObservabilityMetricType" } }, "required": [ "type", "currentValue", "previousValue" ], "title": "MetricUsageResponse", "type": "object" }, "MetricValueChange": { "description": "Individual change analysis data item", "properties": { "attributeName": { "description": "The name of the attribute being analyzed", "type": "string" }, "attributeValue": { "description": "The value of the attribute being analyzed", "type": "string" }, "attributeValuesChangeMean": { "description": "The mean of attribute value changes for the attribute being analyzed", "format": "double", "type": "number" }, "attributeValuesChangeStd": { "description": "The standard deviation of attribute value changes for the attribute being analyzed", "format": "double", "type": "number" }, "isSignificantChange": { "description": "Whether the change is statistically significant", "type": "boolean" }, "metricValueDelta": { "description": "The delta between analyzed and reference periods", "format": "double", "type": "number" }, "metricValueDeltaAbs": { "description": "The absolute delta between analyzed and reference periods", "format": "double", "type": "number" }, "metricValueInAnalyzedPeriod": { "description": "The metric value in the analyzed period", "format": "double", "type": "number" }, "metricValueInReferencePeriod": { "description": "The metric value in the reference period", "format": "double", "type": "number" }, "overallMetricValueInAnalyzedPeriod": { "description": "The overall metric value in the analyzed period", "format": "double", "type": "number" }, "overallMetricValueInReferencePeriod": { "description": "The overall metric value in the reference period", "format": "double", "type": "number" } }, "required": [ "attributeName", "attributeValue", "attributeValuesChangeMean", "attributeValuesChangeStd", "isSignificantChange", "metricValueDelta", "metricValueDeltaAbs", "metricValueInAnalyzedPeriod", "metricValueInReferencePeriod", "overallMetricValueInAnalyzedPeriod", "overallMetricValueInReferencePeriod" ], "type": "object" }, "MetricValueComparisonFilter": { "additionalProperties": false, "properties": { "condition": { "enum": [ "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO" ], "title": "Condition", "type": "string" }, "null_values_as_zero": { "title": "Null Values As Zero", "type": "boolean" }, "type": { "const": "metric_value_filter", "title": "Type", "type": "string" }, "using": { "title": "Using", "type": "string" }, "value": { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "title": "Value" } }, "required": [ "type", "using", "condition", "value" ], "title": "MetricValueComparisonFilter", "type": "object" }, "MetricValueFilterConditionComparison": { "enum": [ "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO", "LESS_THAN", "LESS_THAN_OR_EQUAL_TO", "EQUAL_TO", "NOT_EQUAL_TO" ], "type": "string" }, "MetricValueFilterConditionRange": { "enum": [ "BETWEEN", "NOT_BETWEEN" ], "type": "string" }, "MetricValueRangeFilter": { "additionalProperties": false, "properties": { "condition": { "enum": [ "BETWEEN", "NOT_BETWEEN" ], "title": "Condition", "type": "string" }, "from": { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "title": "From" }, "null_values_as_zero": { "title": "Null Values As Zero", "type": "boolean" }, "to": { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "title": "To" }, "type": { "const": "metric_value_filter", "title": "Type", "type": "string" }, "using": { "title": "Using", "type": "string" } }, "required": [ "type", "using", "condition", "from", "to" ], "title": "MetricValueRangeFilter", "type": "object" }, "ModelTestResult": { "description": "Per-model test results.", "properties": { "message": { "description": "Message about the model test result.", "type": "string" }, "modelId": { "description": "The model ID that was tested.", "type": "string" }, "successful": { "description": "Whether the model test was successful.", "type": "boolean" } }, "required": [ "message", "modelId", "successful" ], "type": "object" }, "MultipartContent": { "additionalProperties": false, "properties": { "parts": { "description": "Ordered multipart content fragments.", "items": { "discriminator": { "mapping": { "alertProposal": "#/components/schemas/AlertProposalPart", "kda": "#/components/schemas/KeyDriverAnalysisPart", "searchResults": "#/components/schemas/SearchResults", "text": "#/components/schemas/TextPart", "visualization": "#/components/schemas/VisualizationPart", "whatIf": "#/components/schemas/WhatIfAnalysisPart" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/TextPart" }, { "$ref": "#/components/schemas/VisualizationPart" }, { "$ref": "#/components/schemas/KeyDriverAnalysisPart" }, { "$ref": "#/components/schemas/WhatIfAnalysisPart" }, { "$ref": "#/components/schemas/SearchResults" }, { "$ref": "#/components/schemas/AlertProposalPart" } ] }, "title": "Parts", "type": "array" }, "suggestions": { "anyOf": [ { "$ref": "#/components/schemas/Suggestions" }, { "type": "null" } ], "description": "Optional follow-up suggestions for the user. Populated only on the terminal user-visible multipart of a turn." }, "type": { "const": "multipart", "default": "multipart", "description": "Type of item content.", "title": "Type", "type": "string" } }, "required": [ "parts" ], "title": "MultipartContent", "type": "object" }, "NegativeAttributeFilter": { "additionalProperties": false, "description": "Filter able to limit element values by label and related selected negated elements.", "properties": { "negativeAttributeFilter": { "$ref": "#/components/schemas/NegativeAttributeFilterBody", "properties": { "applyOnResult": { "type": "boolean" }, "label": { "$ref": "#/components/schemas/AfmIdentifier" }, "localIdentifier": { "type": "string" }, "notIn": { "$ref": "#/components/schemas/AttributeFilterElements" }, "usesArbitraryValues": { "description": "If true, indicates that the values in notInElements were filled free-form, otherwise they have been picked from existing elements.", "type": "boolean" } }, "required": [ "label", "notIn" ], "type": "object" } }, "required": [ "negativeAttributeFilter" ], "title": "NegativeAttributeFilter", "type": "object" }, "NegativeAttributeFilterBody": { "additionalProperties": false, "properties": { "applyOnResult": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Applyonresult" }, "label": { "anyOf": [ { "$ref": "#/components/schemas/AfmObjectIdentifier" }, { "$ref": "#/components/schemas/AfmLocalIdentifier" } ], "title": "Label" }, "localIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Localidentifier" }, "notIn": { "$ref": "#/components/schemas/AttributeFilterElements" }, "usesArbitraryValues": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Usesarbitraryvalues" } }, "required": [ "label", "notIn" ], "title": "NegativeAttributeFilterBody", "type": "object" }, "Note": { "properties": { "appliesTo": { "enum": [ "SOURCE", "TARGET" ], "type": "string" }, "category": { "type": "string" }, "content": { "type": "string" }, "id": { "type": "string" }, "otherAttributes": { "additionalProperties": { "type": "string" }, "type": "object" }, "priority": { "format": "int32", "type": "integer" } }, "type": "object" }, "Notes": { "properties": { "note": { "items": { "$ref": "#/components/schemas/Note" }, "type": "array" } }, "type": "object" }, "Notification": { "properties": { "automationId": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "data": { "oneOf": [ { "$ref": "#/components/schemas/AutomationNotification" }, { "$ref": "#/components/schemas/TestNotification" } ] }, "id": { "type": "string" }, "isRead": { "type": "boolean" }, "workspaceId": { "type": "string" } }, "required": [ "createdAt", "data", "id", "isRead" ], "type": "object" }, "NotificationChannelDestination": { "oneOf": [ { "$ref": "#/components/schemas/Webhook" }, { "$ref": "#/components/schemas/Smtp" }, { "$ref": "#/components/schemas/DefaultSmtp" }, { "$ref": "#/components/schemas/InPlatform" } ], "type": "object" }, "NotificationChannelRef": { "additionalProperties": false, "properties": { "id": { "description": "Notification channel identifier.", "title": "Id", "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Notification channel display name.", "title": "Name" } }, "required": [ "id" ], "title": "NotificationChannelRef", "type": "object" }, "NotificationContent": { "discriminator": { "mapping": { "AUTOMATION": "#/components/schemas/AutomationNotification", "TEST": "#/components/schemas/TestNotification" }, "propertyName": "type" }, "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "NotificationFilter": { "properties": { "filter": { "type": "string" }, "title": { "type": "string" } }, "required": [ "filter", "title" ], "type": "object" }, "Notifications": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Notification" }, "type": "array" }, "meta": { "$ref": "#/components/schemas/NotificationsMeta" } }, "required": [ "data", "meta" ], "type": "object" }, "NotificationsMeta": { "properties": { "total": { "$ref": "#/components/schemas/NotificationsMetaTotal" } }, "type": "object" }, "NotificationsMetaTotal": { "properties": { "all": { "format": "int64", "type": "integer" }, "unread": { "format": "int64", "type": "integer" } }, "required": [ "all", "unread" ], "type": "object" }, "NumberConstraints": { "properties": { "max": { "format": "double", "type": "number" }, "min": { "format": "double", "type": "number" } }, "type": "object" }, "NumberParameterDefinition": { "properties": { "constraints": { "$ref": "#/components/schemas/NumberConstraints" }, "defaultValue": { "format": "double", "type": "number" }, "type": { "description": "The parameter type.", "enum": [ "NUMBER" ], "type": "string" } }, "required": [ "defaultValue", "type" ], "type": "object" }, "ObjectLinks": { "properties": { "self": { "description": "A string containing the link's URL.", "format": "uri", "type": "string" } }, "required": [ "self" ], "type": "object" }, "ObjectLinksContainer": { "properties": { "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "type": "object" }, "ObjectReference": { "properties": { "id": { "description": "Object identifier (e.g. widget ID, metric ID).", "type": "string" }, "type": { "description": "Type of the referenced object.", "enum": [ "WIDGET", "METRIC", "ATTRIBUTE", "DASHBOARD" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "ObjectReferenceGroup": { "properties": { "context": { "$ref": "#/components/schemas/ObjectReference" }, "objects": { "description": "Objects the user explicitly referenced within this context.", "items": { "$ref": "#/components/schemas/ObjectReference" }, "type": "array" } }, "required": [ "objects" ], "type": "object" }, "ObjectStorageInfo": { "description": "Descriptor of a registered ObjectStorage. Provider credentials are stripped \u2014 only fields useful for identifying the storage are returned.", "properties": { "name": { "description": "Human-readable name. Use this as `sourceStorageName` in CreatePipeTable, or pass `storageId` to ProvisionDatabase.storageIds.", "example": "s3-data-lake", "type": "string" }, "storageConfig": { "additionalProperties": { "description": "Provider-specific descriptors (e.g. bucket, region, endpoint, container). Credential references (any keys ending in `_env`) are stripped server-side.", "type": "string" }, "description": "Provider-specific descriptors (e.g. bucket, region, endpoint, container). Credential references (any keys ending in `_env`) are stripped server-side.", "type": "object" }, "storageId": { "description": "Stable identifier of the storage configuration (UUID).", "type": "string" }, "storageType": { "description": "Provider type.", "example": "s3", "type": "string" } }, "required": [ "name", "storageConfig", "storageId", "storageType" ], "type": "object" }, "ObjectType": { "enum": [ "unidentified", "workspace", "dataset", "date", "fact", "metric", "attribute", "date_attribute", "label", "visualization", "dashboard", "filter_context", "parameter" ], "title": "ObjectType", "type": "string" }, "ObservabilityMetricType": { "description": "Metrics exposed by the AI observability endpoint.", "enum": [ "AI_QUERIES", "AI_WORKSPACES", "AI_USERS" ], "title": "ObservabilityMetricType", "type": "string" }, "ObservabilityOverviewResponse": { "properties": { "metrics": { "items": { "$ref": "#/components/schemas/MetricUsageResponse" }, "title": "Metrics", "type": "array" } }, "required": [ "metrics" ], "title": "ObservabilityOverviewResponse", "type": "object" }, "OpenAIProviderConfig": { "description": "Configuration for OpenAI provider.", "properties": { "auth": { "$ref": "#/components/schemas/OpenAiProviderAuth" }, "baseUrl": { "default": "https://api.openai.com/v1", "description": "Custom base URL for OpenAI API.", "maxLength": 255, "type": "string" }, "organization": { "description": "OpenAI organization ID.", "maxLength": 255, "nullable": true, "type": "string" }, "type": { "description": "Provider type.", "enum": [ "OPENAI" ], "type": "string" } }, "required": [ "auth", "type" ], "type": "object" }, "OpenAiApiKeyAuth": { "allOf": [ { "properties": { "apiKey": { "description": "OpenAI API key.", "maxLength": 255, "nullable": true, "type": "string", "writeOnly": true }, "type": { "description": "Authentication type.", "enum": [ "API_KEY" ], "type": "string" } }, "type": "object" } ], "required": [ "type" ], "type": "object" }, "OpenAiProviderAuth": { "description": "Authentication configuration.", "oneOf": [ { "$ref": "#/components/schemas/OpenAiApiKeyAuth" } ], "type": "object" }, "OpenTelemetryService": { "description": "OpenTelemetry service.", "properties": { "host": { "description": "Telemetry host to send events to.", "type": "string" } }, "required": [ "host" ], "type": "object" }, "Operation": { "description": "Represents a Long-Running Operation: a process that takes some time to complete.", "discriminator": { "mapping": { "failed": "#/components/schemas/FailedOperation", "pending": "#/components/schemas/PendingOperation", "succeeded": "#/components/schemas/SucceededOperation" }, "propertyName": "status" }, "properties": { "id": { "description": "Id of the operation", "type": "string" }, "kind": { "description": "Type of the long-running operation.\n* `provision-database` \u2014 Provisioning of an AI Lake database.\n* `deprovision-database` \u2014 Deprovisioning (deletion) of an AI Lake database.\n* `run-service-command` \u2014 Running a command in a particular AI Lake service.\n* `create-pipe-table` \u2014 Creating a pipe table backed by an S3 data source.\n* `delete-pipe-table` \u2014 Deleting a pipe table.\n* `analyze-statistics` \u2014 Running ANALYZE TABLE for CBO statistics collection.\n* `refresh-partition` \u2014 Refreshing a specific Hive partition (delete + re-load from S3).\n", "enum": [ "provision-database", "deprovision-database", "run-service-command", "create-pipe-table", "delete-pipe-table", "analyze-statistics", "refresh-partition" ], "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "kind", "status" ], "type": "object" }, "OperationError": { "description": "Error information for a failed operation", "properties": { "detail": { "description": "Human-readable error details", "type": "string" }, "status": { "description": "HTTP status code", "format": "int32", "type": "integer" }, "title": { "description": "Human-readable error name", "type": "string" } }, "required": [ "detail", "status", "title" ], "type": "object" }, "OrganizationAutomationIdentifier": { "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" } }, "required": [ "id", "workspaceId" ], "type": "object" }, "OrganizationAutomationManagementBulkRequest": { "properties": { "automations": { "items": { "$ref": "#/components/schemas/OrganizationAutomationIdentifier" }, "type": "array" } }, "required": [ "automations" ], "type": "object" }, "OrganizationCacheSettings": { "description": "Settings for organization cache.", "properties": { "extraCacheBudget": { "description": "Extra cache budget the organization can allocate among its workspaces, in bytes.", "format": "int64", "type": "integer" } }, "required": [ "extraCacheBudget" ], "type": "object" }, "OrganizationCacheUsage": { "description": "Data about the whole organization's cache usage.", "properties": { "current": { "$ref": "#/components/schemas/OrganizationCurrentCacheUsage" }, "removalIntervals": { "description": "List of cache removal intervals.", "items": { "$ref": "#/components/schemas/CacheRemovalInterval" }, "type": "array" }, "settings": { "$ref": "#/components/schemas/OrganizationCacheSettings" } }, "required": [ "current", "removalIntervals", "settings" ], "type": "object" }, "OrganizationCurrentCacheUsage": { "description": "Current cache usage of the organization.", "properties": { "cacheUsed": { "description": "Cache currently used by the organization, in bytes.", "format": "int64", "type": "integer" }, "removalPeriodStart": { "description": "Start timestamp of removal period.", "format": "date-time", "type": "string" }, "removedSinceStart": { "description": "Bytes removed since start due to insufficient cache.", "format": "int64", "type": "integer" } }, "required": [ "cacheUsed", "removedSinceStart" ], "type": "object" }, "OrganizationPermissionAssignment": { "description": "Organization permission assignments", "properties": { "assigneeIdentifier": { "$ref": "#/components/schemas/AssigneeIdentifier" }, "permissions": { "items": { "enum": [ "MANAGE", "SELF_CREATE_TOKEN", "BASE_UI_ACCESS" ], "type": "string" }, "type": "array" } }, "required": [ "assigneeIdentifier", "permissions" ], "type": "object" }, "OutlierDetectionRequest": { "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 the execution result.", "items": { "oneOf": [ { "$ref": "#/components/schemas/AbstractMeasureValueFilter" }, { "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" }, { "$ref": "#/components/schemas/InlineFilterDefinition" } ] }, "type": "array" }, "granularity": { "description": "Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR).", "enum": [ "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR" ], "type": "string" }, "measures": { "items": { "$ref": "#/components/schemas/MeasureItem" }, "minItems": 1, "type": "array" }, "sensitivity": { "description": "Sensitivity level for outlier detection", "enum": [ "LOW", "MEDIUM", "HIGH" ], "type": "string" } }, "required": [ "attributes", "filters", "granularity", "measures", "sensitivity" ], "type": "object" }, "OutlierDetectionResponse": { "properties": { "links": { "$ref": "#/components/schemas/ExecutionLinks" } }, "required": [ "links" ], "type": "object" }, "OutlierDetectionResult": { "properties": { "attribute": { "description": "Attribute values for outlier detection results.", "items": { "type": "string" }, "nullable": true, "type": "array" }, "values": { "additionalProperties": { "description": "Map of measure identifiers to their outlier detection values. Each value is a list of nullable numbers.", "items": { "description": "Map of measure identifiers to their outlier detection values. Each value is a list of nullable numbers.", "nullable": true, "type": "number" }, "nullable": true, "type": "array" }, "description": "Map of measure identifiers to their outlier detection values. Each value is a list of nullable numbers.", "nullable": true, "type": "object" } }, "required": [ "attribute", "values" ], "type": "object" }, "Over": { "properties": { "attributes": { "items": { "$ref": "#/components/schemas/IdentifierRef" }, "type": "array" } }, "required": [ "attributes" ], "type": "object" }, "PageMetadata": { "properties": { "number": { "description": "The number of the current page", "format": "int32", "type": "integer" }, "size": { "description": "The size of the current page", "format": "int32", "type": "integer" }, "totalElements": { "description": "The total number of elements", "format": "int32", "type": "integer" }, "totalPages": { "description": "The total number of pages", "format": "int32", "type": "integer" } }, "type": "object" }, "Paging": { "description": "Current page description.", "properties": { "count": { "description": "Count of items in this page.", "example": 5, "format": "int32", "type": "integer" }, "next": { "description": "Link to next page, or null if this is last page.", "example": "https://sample.gooddata.ai/api/v1/actions/workspaces/sampleWorkspace/execution/collectLabelElements?label=sample.price&limit=5&offset=10", "type": "string" }, "offset": { "description": "Offset of this page.", "example": 10, "format": "int32", "type": "integer" }, "total": { "description": "Count of returnable items ignoring paging.", "example": 100, "format": "int32", "type": "integer" } }, "required": [ "count", "offset", "total" ], "type": "object" }, "Parameter": { "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "ParameterDefinition": { "description": "Parameter content (type-discriminated).", "discriminator": { "mapping": { "NUMBER": "#/components/schemas/NumberParameterDefinition", "STRING": "#/components/schemas/StringParameterDefinition" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/NumberParameterDefinition" }, { "$ref": "#/components/schemas/StringParameterDefinition" } ], "type": "object" }, "ParameterItem": { "description": "(EXPERIMENTAL) Parameter value for this execution.", "properties": { "parameter": { "$ref": "#/components/schemas/AfmObjectIdentifierParameter" }, "value": { "description": "Value to use for this parameter instead of its default.", "type": "string" } }, "required": [ "parameter", "value" ], "type": "object" }, "ParameterValue": { "description": "Parameter value override applied to the export. The (id, value) pair drives the execution; the title is FE-supplied for info-sheet display.", "properties": { "id": { "description": "Identifier of the workspace parameter (matches the parameter entity id).", "example": "year", "type": "string" }, "title": { "description": "Display title of the parameter as the client wants it rendered on the info sheet.", "example": "Year", "type": "string" }, "value": { "description": "Value to use for this parameter when executing the export.", "example": "2026", "type": "string" } }, "required": [ "id", "title", "value" ], "type": "object" }, "PartitionConfig": { "description": "Partition configuration for the table.", "discriminator": { "mapping": { "column": "#/components/schemas/ColumnPartitionConfig", "dateTrunc": "#/components/schemas/DateTruncPartitionConfig", "timeSlice": "#/components/schemas/TimeSlicePartitionConfig" }, "propertyName": "type" }, "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "PdfTableStyle": { "deprecated": true, "description": "Custom CSS styles for the table. (PDF, HTML)", "example": [ { "properties": [ { "key": "font-size", "value": "30px" } ], "selector": "th" } ], "properties": { "properties": { "description": "List of CSS properties.", "items": { "$ref": "#/components/schemas/PdfTableStyleProperty" }, "type": "array" }, "selector": { "description": "CSS selector where to apply given properties.", "type": "string" } }, "required": [ "selector" ], "type": "object" }, "PdfTableStyleProperty": { "description": "CSS property.", "properties": { "key": { "description": "CSS property key.", "type": "string" }, "value": { "description": "CSS property value.", "type": "string" } }, "required": [ "key", "value" ], "type": "object" }, "PdmLdmRequest": { "description": "PDM additions wrapper.", "properties": { "sqls": { "description": "List of SQL datasets.", "items": { "$ref": "#/components/schemas/PdmSql" }, "type": "array" }, "tableOverrides": { "description": "(BETA) List of table overrides.", "items": { "$ref": "#/components/schemas/TableOverride" }, "type": "array" }, "tables": { "description": "List of physical database tables.", "items": { "$ref": "#/components/schemas/DeclarativeTable" }, "type": "array" } }, "type": "object" }, "PdmSql": { "description": "SQL dataset definition.", "properties": { "columns": { "description": "Columns defining SQL dataset.", "items": { "$ref": "#/components/schemas/SqlColumn" }, "type": "array" }, "statement": { "description": "SQL statement.", "example": "select * from abc", "type": "string" }, "title": { "description": "SQL dataset title.", "example": "My special dataset", "type": "string" } }, "required": [ "statement", "title" ], "type": "object" }, "PendingOperation": { "allOf": [ { "$ref": "#/components/schemas/Operation" } ], "description": "Operation that is still pending", "required": [ "id", "kind" ], "type": "object" }, "PermissionsAssignment": { "properties": { "assignees": { "items": { "$ref": "#/components/schemas/AssigneeIdentifier" }, "type": "array" }, "dataSources": { "items": { "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" }, "type": "array" }, "workspaces": { "items": { "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" }, "type": "array" } }, "required": [ "assignees" ], "type": "object" }, "PermissionsForAssignee": { "allOf": [ { "$ref": "#/components/schemas/DashboardPermissionsAssignment" }, { "properties": { "assigneeIdentifier": { "$ref": "#/components/schemas/AssigneeIdentifier" } }, "type": "object" } ], "description": "Desired levels of permissions for an assignee identified by an identifier.", "required": [ "assigneeIdentifier", "permissions" ], "type": "object" }, "PermissionsForAssigneeRule": { "allOf": [ { "$ref": "#/components/schemas/DashboardPermissionsAssignment" }, { "properties": { "assigneeRule": { "$ref": "#/components/schemas/AssigneeRule" } }, "type": "object" } ], "description": "Desired levels of permissions for a collection of assignees identified by a rule.", "required": [ "assigneeRule", "permissions" ], "type": "object" }, "PipeTable": { "description": "Full details of a pipe-backed OLAP table", "properties": { "columns": { "description": "Inferred column schema", "items": { "$ref": "#/components/schemas/ColumnInfo" }, "type": "array" }, "databaseName": { "description": "Database name", "type": "string" }, "distributionConfig": { "oneOf": [ { "$ref": "#/components/schemas/HashDistributionConfig" }, { "$ref": "#/components/schemas/RandomDistributionConfig" } ] }, "keyConfig": { "oneOf": [ { "$ref": "#/components/schemas/AggregateKeyConfig" }, { "$ref": "#/components/schemas/DuplicateKeyConfig" }, { "$ref": "#/components/schemas/PrimaryKeyConfig" }, { "$ref": "#/components/schemas/UniqueKeyConfig" } ] }, "partitionColumns": { "description": "Hive partition columns detected from the path structure", "items": { "description": "Hive partition columns detected from the path structure", "type": "string" }, "type": "array" }, "partitionConfig": { "oneOf": [ { "$ref": "#/components/schemas/ColumnPartitionConfig" }, { "$ref": "#/components/schemas/DateTruncPartitionConfig" }, { "$ref": "#/components/schemas/TimeSlicePartitionConfig" } ] }, "pathPrefix": { "description": "Path prefix to the parquet files", "type": "string" }, "pipeTableId": { "description": "Internal UUID of the pipe table record", "type": "string" }, "pollingIntervalSeconds": { "description": "How often (in seconds) the pipe polls for new files. 0 = server default.", "format": "int32", "type": "integer" }, "sourceStorageName": { "description": "Source ObjectStorage name", "type": "string" }, "tableName": { "description": "OLAP table name", "type": "string" }, "tableProperties": { "additionalProperties": { "description": "CREATE TABLE PROPERTIES key-value pairs", "type": "string" }, "description": "CREATE TABLE PROPERTIES key-value pairs", "type": "object" } }, "required": [ "columns", "databaseName", "distributionConfig", "keyConfig", "partitionColumns", "pathPrefix", "pipeTableId", "pollingIntervalSeconds", "sourceStorageName", "tableName", "tableProperties" ], "type": "object" }, "PipeTableSummary": { "description": "Lightweight pipe table entry used in list responses", "properties": { "columns": { "description": "Inferred column schema", "items": { "$ref": "#/components/schemas/ColumnInfo" }, "type": "array" }, "pathPrefix": { "description": "Path prefix to the parquet files", "type": "string" }, "pipeTableId": { "description": "Internal UUID of the pipe table record", "type": "string" }, "tableName": { "description": "OLAP table name", "type": "string" } }, "required": [ "columns", "pathPrefix", "pipeTableId", "tableName" ], "type": "object" }, "PlatformUsage": { "properties": { "count": { "format": "int32", "type": "integer" }, "name": { "enum": [ "UserCount", "WorkspaceCount", "AiWorkspaceCount" ], "type": "string" } }, "required": [ "name" ], "type": "object" }, "PlatformUsageRequest": { "properties": { "usageItemNames": { "items": { "enum": [ "UserCount", "WorkspaceCount", "AiWorkspaceCount" ], "type": "string" }, "type": "array", "uniqueItems": true } }, "required": [ "usageItemNames" ], "type": "object" }, "PopDataset": { "description": "Combination of the date data set to use and how many periods ago to calculate the previous period for.", "properties": { "dataset": { "$ref": "#/components/schemas/AfmObjectIdentifierDataset" }, "periodsAgo": { "description": "Number of periods ago to calculate the previous period for.", "example": 1, "format": "int32", "type": "integer" } }, "required": [ "dataset", "periodsAgo" ], "type": "object" }, "PopDatasetMeasureDefinition": { "description": "Previous period type of metric.", "properties": { "previousPeriodMeasure": { "properties": { "dateDatasets": { "description": "Specification of which date data sets to use for determining the period to calculate the previous period for.", "items": { "$ref": "#/components/schemas/PopDataset" }, "type": "array" }, "measureIdentifier": { "$ref": "#/components/schemas/AfmLocalIdentifier" } }, "required": [ "dateDatasets", "measureIdentifier" ], "type": "object" } }, "required": [ "previousPeriodMeasure" ], "type": "object" }, "PopDate": { "description": "Combination of the date attribute to use and how many periods ago to calculate the PoP for.", "properties": { "attribute": { "$ref": "#/components/schemas/AfmObjectIdentifierAttribute" }, "periodsAgo": { "description": "Number of periods ago to calculate the previous period for.", "example": 1, "format": "int32", "type": "integer" } }, "required": [ "attribute", "periodsAgo" ], "type": "object" }, "PopDateMeasureDefinition": { "description": "Period over period type of metric.", "properties": { "overPeriodMeasure": { "properties": { "dateAttributes": { "description": "Attributes to use for determining the period to calculate the PoP for.", "items": { "$ref": "#/components/schemas/PopDate" }, "type": "array" }, "measureIdentifier": { "$ref": "#/components/schemas/AfmLocalIdentifier" } }, "required": [ "dateAttributes", "measureIdentifier" ], "type": "object" } }, "required": [ "overPeriodMeasure" ], "type": "object" }, "PopMeasureDefinition": { "oneOf": [ { "$ref": "#/components/schemas/PopDatasetMeasureDefinition" }, { "$ref": "#/components/schemas/PopDateMeasureDefinition" } ], "type": "object" }, "PositiveAttributeFilter": { "additionalProperties": false, "description": "Filter able to limit element values by label and related selected elements.", "properties": { "positiveAttributeFilter": { "$ref": "#/components/schemas/PositiveAttributeFilterBody", "properties": { "applyOnResult": { "type": "boolean" }, "in": { "$ref": "#/components/schemas/AttributeFilterElements" }, "label": { "$ref": "#/components/schemas/AfmIdentifier" }, "localIdentifier": { "type": "string" }, "usesArbitraryValues": { "description": "If true, indicates that the values in inElements were filled free-form, otherwise they have been picked from existing elements.", "type": "boolean" } }, "required": [ "in", "label" ], "type": "object" } }, "required": [ "positiveAttributeFilter" ], "title": "PositiveAttributeFilter", "type": "object" }, "PositiveAttributeFilterBody": { "additionalProperties": false, "properties": { "applyOnResult": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Applyonresult" }, "in": { "$ref": "#/components/schemas/AttributeFilterElements" }, "label": { "anyOf": [ { "$ref": "#/components/schemas/AfmObjectIdentifier" }, { "$ref": "#/components/schemas/AfmLocalIdentifier" } ], "title": "Label" }, "localIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Localidentifier" }, "usesArbitraryValues": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Usesarbitraryvalues" } }, "required": [ "label", "in" ], "title": "PositiveAttributeFilterBody", "type": "object" }, "PrimaryKeyConfig": { "description": "Primary key model \u2014 enforces uniqueness, replaces on conflict.", "properties": { "columns": { "description": "Key columns. Defaults to first inferred column.", "items": { "description": "Key columns. Defaults to first inferred column.", "type": "string" }, "type": "array" } }, "type": "object" }, "Profile": { "properties": { "entitlements": { "description": "Defines entitlements for given organization.", "items": { "$ref": "#/components/schemas/ApiEntitlement" }, "type": "array" }, "features": { "oneOf": [ { "$ref": "#/components/schemas/LiveFeatures" }, { "$ref": "#/components/schemas/StaticFeatures" } ] }, "links": { "$ref": "#/components/schemas/ProfileLinks" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "organizationName": { "type": "string" }, "permissions": { "items": { "enum": [ "MANAGE", "SELF_CREATE_TOKEN", "BASE_UI_ACCESS" ], "type": "string" }, "type": "array" }, "telemetryConfig": { "$ref": "#/components/schemas/TelemetryConfig" }, "userId": { "type": "string" } }, "required": [ "entitlements", "features", "links", "organizationId", "organizationName", "permissions", "telemetryConfig", "userId" ], "type": "object" }, "ProfileLinks": { "properties": { "organization": { "type": "string" }, "self": { "type": "string" }, "user": { "type": "string" } }, "required": [ "organization", "self", "user" ], "type": "object" }, "ProvisionDatabaseInstanceRequest": { "description": "Request to provision a new AILake Database instance", "properties": { "dataSourceId": { "description": "Identifier for the data source created in metadata-api. Defaults to the database name.", "type": "string" }, "dataSourceName": { "description": "Display name for the data source created in metadata-api. Defaults to the database name.", "type": "string" }, "name": { "description": "Name of the database instance", "type": "string" }, "storageIds": { "description": "Set of ids of the storage instances this database instance should access.", "items": { "description": "Set of ids of the storage instances this database instance should access.", "type": "string" }, "type": "array", "uniqueItems": true } }, "required": [ "name", "storageIds" ], "type": "object" }, "QualityIssue": { "description": "List of quality issues (available when status is COMPLETED)", "properties": { "code": { "description": "Quality issue code", "example": "SIMILAR_NAMES", "type": "string" }, "detail": { "additionalProperties": { "description": "Detailed information about the quality issue", "type": "object" }, "description": "Detailed information about the quality issue", "type": "object" }, "id": { "description": "Unique identifier for the quality issue", "type": "string" }, "objects": { "description": "List of objects affected by this quality issue", "items": { "$ref": "#/components/schemas/QualityIssueObject" }, "type": "array" }, "severity": { "description": "Severity level", "enum": [ "WARNING", "INFO" ], "type": "string" } }, "required": [ "code", "detail", "id", "objects", "severity" ], "type": "object" }, "QualityIssueObject": { "description": "List of objects affected by this quality issue", "properties": { "id": { "description": "Object ID", "example": "revenue", "type": "string" }, "title": { "description": "Object title", "example": "Total Revenue", "type": "string" }, "type": { "description": "Object type", "example": "metric", "type": "string" }, "workspaceId": { "description": "Workspace ID where the object belongs", "example": "demo", "type": "string" } }, "required": [ "id", "title", "type", "workspaceId" ], "type": "object" }, "QualityIssuesCalculationStatusResponse": { "properties": { "error": { "description": "Error message (available when status is FAILED or NOT_FOUND)", "type": "string" }, "issues": { "description": "List of quality issues (available when status is COMPLETED)", "items": { "$ref": "#/components/schemas/QualityIssue" }, "type": "array" }, "status": { "description": "Current status of the calculation", "enum": [ "RUNNING", "SYNCING", "COMPLETED", "FAILED", "CANCELLED", "NOT_FOUND", "DISABLED" ], "type": "string" } }, "required": [ "status" ], "type": "object" }, "Query": { "additionalProperties": false, "properties": { "fields": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "$ref": "#/components/schemas/QueryFieldMeasure" }, { "$ref": "#/components/schemas/QueryFieldAttribute" } ] }, "title": "Fields", "type": "object" }, "filter_by": { "additionalProperties": { "anyOf": [ { "$ref": "#/components/schemas/AttributeFilter" }, { "$ref": "#/components/schemas/DateFilterAbsolute" }, { "$ref": "#/components/schemas/DateFilterRelative" }, { "$ref": "#/components/schemas/app__domain__conversations__visualization__RankingFilter" }, { "$ref": "#/components/schemas/MetricValueComparisonFilter" }, { "$ref": "#/components/schemas/MetricValueRangeFilter" }, { "$ref": "#/components/schemas/TextFilterValues" }, { "$ref": "#/components/schemas/TextFilterValue" } ] }, "title": "Filter By", "type": "object" }, "sort_by": { "items": { "anyOf": [ { "$ref": "#/components/schemas/AttributeSortItem" }, { "$ref": "#/components/schemas/MetricSortItem" } ] }, "title": "Sort By", "type": "array" } }, "required": [ "fields" ], "title": "Query", "type": "object" }, "QueryFieldAttribute": { "additionalProperties": false, "properties": { "show_all_values": { "title": "Show All Values", "type": "boolean" }, "title": { "title": "Title", "type": "string" }, "using": { "title": "Using", "type": "string" } }, "required": [ "using" ], "title": "QueryFieldAttribute", "type": "object" }, "QueryFieldMeasure": { "additionalProperties": false, "description": "Metric/fact/attribute measure field (attribute requires COUNT).", "properties": { "aggregation": { "enum": [ "SUM", "AVG", "MIN", "MAX", "MEDIAN", "COUNT" ], "title": "Aggregation", "type": "string" }, "title": { "title": "Title", "type": "string" }, "using": { "title": "Using", "type": "string" } }, "required": [ "using" ], "title": "QueryFieldMeasure", "type": "object" }, "RandomDistributionConfig": { "description": "Random distribution across buckets.", "properties": { "buckets": { "description": "Number of random distribution buckets. Defaults to 1.", "format": "int32", "minimum": 1, "type": "integer" } }, "type": "object" }, "Range": { "additionalProperties": false, "properties": { "from": { "$ref": "#/components/schemas/Value", "description": "Range lower bound." }, "measure": { "$ref": "#/components/schemas/LocalIdentifier", "description": "Metric being compared." }, "operator": { "$ref": "#/components/schemas/RangeConditionOperator", "description": "Range operator.", "enum": [ "BETWEEN", "NOT_BETWEEN" ], "type": "string" }, "to": { "$ref": "#/components/schemas/Value", "description": "Range upper bound." } }, "required": [ "from", "measure", "operator", "to" ], "title": "Range", "type": "object" }, "RangeCondition": { "additionalProperties": false, "description": "Condition that checks if the metric value is within a given range.", "properties": { "range": { "$ref": "#/components/schemas/Range", "description": "Range condition.", "properties": { "from": { "example": 100, "type": "number" }, "operator": { "enum": [ "BETWEEN", "NOT_BETWEEN" ], "example": "BETWEEN", "type": "string" }, "to": { "example": 999, "type": "number" } }, "required": [ "from", "operator", "to" ], "type": "object" } }, "required": [ "range" ], "title": "RangeCondition", "type": "object" }, "RangeConditionOperator": { "description": "Operator of a range condition.", "enum": [ "BETWEEN", "NOT_BETWEEN" ], "title": "RangeConditionOperator", "type": "string" }, "RangeMeasureValueFilter": { "additionalProperties": false, "description": "Filter the result by comparing specified metric to given range of values.", "properties": { "rangeMeasureValueFilter": { "$ref": "#/components/schemas/RangeMeasureValueFilterBody", "properties": { "applyOnResult": { "type": "boolean" }, "dimensionality": { "description": "References to the attributes to be used when filtering.", "items": { "$ref": "#/components/schemas/AfmIdentifier" }, "type": "array" }, "from": { "example": 100, "type": "number" }, "localIdentifier": { "type": "string" }, "measure": { "$ref": "#/components/schemas/AfmIdentifier" }, "operator": { "enum": [ "BETWEEN", "NOT_BETWEEN" ], "example": "BETWEEN", "type": "string" }, "to": { "example": 999, "type": "number" }, "treatNullValuesAs": { "description": "A value that will be substituted for null values in the metric for the comparisons.", "example": 0, "type": "number" } }, "required": [ "from", "measure", "operator", "to" ], "type": "object" } }, "required": [ "rangeMeasureValueFilter" ], "title": "RangeMeasureValueFilter", "type": "object" }, "RangeMeasureValueFilterBody": { "additionalProperties": false, "properties": { "applyOnResult": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Applyonresult" }, "dimensionality": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/components/schemas/AfmObjectIdentifier" }, { "$ref": "#/components/schemas/AfmLocalIdentifier" } ] }, "type": "array" }, { "type": "null" } ], "title": "Dimensionality" }, "from": { "title": "From", "type": "number" }, "localIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Localidentifier" }, "measure": { "anyOf": [ { "$ref": "#/components/schemas/AfmObjectIdentifier" }, { "$ref": "#/components/schemas/AfmLocalIdentifier" } ], "title": "Measure" }, "operator": { "$ref": "#/components/schemas/RangeMeasureValueOperator" }, "to": { "title": "To", "type": "number" }, "treatNullValuesAs": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Treatnullvaluesas" } }, "required": [ "measure", "operator", "from", "to" ], "title": "RangeMeasureValueFilterBody", "type": "object" }, "RangeMeasureValueOperator": { "enum": [ "BETWEEN", "NOT_BETWEEN" ], "title": "RangeMeasureValueOperator", "type": "string" }, "RangeWrapper": { "properties": { "range": { "$ref": "#/components/schemas/Range" } }, "required": [ "range" ], "type": "object" }, "RankingFilter": { "description": "Filter the result on top/bottom N values according to given metric(s).", "properties": { "rankingFilter": { "properties": { "applyOnResult": { "type": "boolean" }, "dimensionality": { "description": "References to the attributes to be used when filtering.", "items": { "$ref": "#/components/schemas/AfmIdentifier" }, "type": "array" }, "localIdentifier": { "type": "string" }, "measures": { "description": "References to the metrics to be used when filtering.", "items": { "$ref": "#/components/schemas/AfmIdentifier" }, "type": "array" }, "operator": { "description": "The type of ranking to use, TOP or BOTTOM.", "enum": [ "TOP", "BOTTOM" ], "type": "string" }, "strictLimitOfRows": { "description": "When true, filter returns requested number of rows at most. Default is false.", "type": "boolean" }, "value": { "description": "Number of top/bottom values to filter.", "example": 5, "format": "int32", "type": "integer" } }, "required": [ "measures", "operator", "value" ], "type": "object" } }, "required": [ "rankingFilter" ], "type": "object" }, "RankingFilter-Input": { "additionalProperties": false, "properties": { "rankingFilter": { "$ref": "#/components/schemas/RankingFilterBody" } }, "required": [ "rankingFilter" ], "title": "RankingFilter", "type": "object" }, "RankingFilterBody": { "additionalProperties": false, "properties": { "applyOnResult": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Applyonresult" }, "dimensionality": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/components/schemas/AfmObjectIdentifier" }, { "$ref": "#/components/schemas/AfmLocalIdentifier" } ] }, "type": "array" }, { "type": "null" } ], "title": "Dimensionality" }, "localIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Localidentifier" }, "measures": { "items": { "anyOf": [ { "$ref": "#/components/schemas/AfmObjectIdentifier" }, { "$ref": "#/components/schemas/AfmLocalIdentifier" } ] }, "title": "Measures", "type": "array" }, "operator": { "$ref": "#/components/schemas/RankingOperator" }, "value": { "title": "Value", "type": "integer" } }, "required": [ "measures", "operator", "value" ], "title": "RankingFilterBody", "type": "object" }, "RankingOperator": { "enum": [ "TOP", "BOTTOM" ], "title": "RankingOperator", "type": "string" }, "RawCustomLabel": { "description": "Custom label object override.", "properties": { "title": { "description": "Override value.", "type": "string" } }, "required": [ "title" ], "type": "object" }, "RawCustomMetric": { "description": "Custom metric object override.", "properties": { "title": { "description": "Metric title override.", "type": "string" } }, "required": [ "title" ], "type": "object" }, "RawCustomOverride": { "description": "Custom cell value overrides (IDs will be replaced with specified values).", "properties": { "labels": { "additionalProperties": { "$ref": "#/components/schemas/RawCustomLabel" }, "description": "Map of CustomLabels with keys used as placeholders in export result.", "type": "object" }, "metrics": { "additionalProperties": { "$ref": "#/components/schemas/RawCustomMetric" }, "description": "Map of CustomMetrics with keys used as placeholders in export result.", "type": "object" } }, "type": "object" }, "RawExportAutomationRequest": { "description": "Export request object describing the export properties and overrides for raw exports.", "properties": { "customOverride": { "$ref": "#/components/schemas/RawCustomOverride" }, "delimiter": { "description": "Set column delimiter. (CSV)", "maxLength": 1, "minLength": 1, "pattern": "^[\\t !#$%&()*+\\-.,/:;<=>?@\\[\\\\\\]^_{|}~]$", "type": "string" }, "execution": { "$ref": "#/components/schemas/AFM" }, "executionSettings": { "$ref": "#/components/schemas/ExecutionSettings" }, "fileName": { "description": "Filename of downloaded file without extension.", "example": "result", "type": "string" }, "format": { "description": "Requested resulting file type.", "enum": [ "ARROW_FILE", "ARROW_STREAM", "CSV" ], "example": "CSV", "type": "string" }, "metadata": { "$ref": "#/components/schemas/JsonNode" } }, "required": [ "execution", "fileName", "format" ], "type": "object" }, "RawExportRequest": { "description": "Export request object describing the export properties and overrides for raw exports.", "properties": { "customOverride": { "$ref": "#/components/schemas/RawCustomOverride" }, "delimiter": { "description": "Set column delimiter. (CSV)", "maxLength": 1, "minLength": 1, "pattern": "^[\\t !#$%&()*+\\-.,/:;<=>?@\\[\\\\\\]^_{|}~]$", "type": "string" }, "execution": { "$ref": "#/components/schemas/AFM" }, "executionSettings": { "$ref": "#/components/schemas/ExecutionSettings" }, "fileName": { "description": "Filename of downloaded file without extension.", "example": "result", "type": "string" }, "format": { "description": "Requested resulting file type.", "enum": [ "ARROW_FILE", "ARROW_STREAM", "CSV" ], "example": "CSV", "type": "string" } }, "required": [ "execution", "fileName", "format" ], "type": "object" }, "ReadCsvFileManifestsRequest": { "description": "Request to read the manifests of the specified CSV files.", "properties": { "manifestRequests": { "description": "Files to read the manifests for.", "items": { "$ref": "#/components/schemas/ReadCsvFileManifestsRequestItem" }, "type": "array" } }, "required": [ "manifestRequests" ], "type": "object" }, "ReadCsvFileManifestsRequestItem": { "description": "Request to read the manifest of a single CSV file.", "properties": { "fileName": { "description": "Name of the CSV file to read the manifest for.", "type": "string" }, "version": { "description": "Optional version of the file to read the manifest for. If null or not specified, the latest version is read.", "format": "int32", "type": "integer" } }, "required": [ "fileName" ], "type": "object" }, "ReadCsvFileManifestsResponse": { "description": "Describes the results of a CSV manifest read of a single file.", "properties": { "manifest": { "$ref": "#/components/schemas/CsvManifestBody" }, "name": { "description": "Name of the file in the source data source.", "type": "string" }, "version": { "description": "Version of the file in the source data source.", "format": "int32", "type": "integer" } }, "required": [ "manifest", "name", "version" ], "type": "object" }, "Reasoning": { "description": "Reasoning wrapper containing steps taken during request handling.", "properties": { "answer": { "description": "Final answer/reasoning from the use case result.", "type": "string" }, "steps": { "description": "Steps taken during processing, showing the AI's reasoning process.", "items": { "$ref": "#/components/schemas/ReasoningStep" }, "type": "array" } }, "required": [ "steps" ], "type": "object" }, "ReasoningContent": { "additionalProperties": false, "properties": { "summary": { "description": "Reasoning summary intended for UI display.", "title": "Summary", "type": "string" }, "type": { "const": "reasoning", "default": "reasoning", "description": "Type of item content.", "title": "Type", "type": "string" } }, "required": [ "summary" ], "title": "ReasoningContent", "type": "object" }, "ReasoningStep": { "description": "Steps taken during processing, showing the AI's reasoning process.", "properties": { "thoughts": { "description": "Detailed thoughts/messages within this step.", "items": { "$ref": "#/components/schemas/Thought" }, "type": "array" }, "title": { "description": "Title describing this reasoning step.", "type": "string" } }, "required": [ "thoughts", "title" ], "type": "object" }, "ReferenceIdentifier": { "description": "A reference identifier.", "properties": { "id": { "description": "Reference ID.", "example": "customers", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "A type of the reference.", "enum": [ "dataset" ], "example": "DATASET", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "ReferenceSourceColumn": { "properties": { "column": { "type": "string" }, "dataType": { "enum": [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN", "HLL" ], "type": "string" }, "isNullable": { "type": "boolean" }, "nullValue": { "type": "string" }, "target": { "$ref": "#/components/schemas/DatasetGrain" } }, "required": [ "target" ], "type": "object" }, "RefreshPartitionRequest": { "description": "Request to refresh a specific Hive partition in a pipe-backed OLAP table", "properties": { "partitionSpec": { "additionalProperties": { "description": "Partition column values identifying the partition to refresh. Keys must match the table's partition_columns exactly. Example: {\"date\": \"2026-01-01\"}", "type": "string" }, "description": "Partition column values identifying the partition to refresh. Keys must match the table's partition_columns exactly. Example: {\"date\": \"2026-01-01\"}", "type": "object" } }, "required": [ "partitionSpec" ], "type": "object" }, "Relative": { "additionalProperties": false, "properties": { "measure": { "$ref": "#/components/schemas/ArithmeticMeasure", "description": "Arithmetic combination of the two metrics." }, "operator": { "$ref": "#/components/schemas/RelativeConditionOperator", "description": "Relative condition operator.\nINCREASES_BY - the metric increases by the specified value.\nDECREASES_BY - the metric decreases by the specified value.\nCHANGES_BY - the metric increases or decreases by the specified value.\n", "enum": [ "INCREASES_BY", "DECREASES_BY", "CHANGES_BY" ], "type": "string" }, "threshold": { "$ref": "#/components/schemas/Value", "description": "Threshold the relative change is compared to." } }, "required": [ "measure", "operator", "threshold" ], "title": "Relative", "type": "object" }, "RelativeBoundedDateFilter": { "properties": { "from": { "format": "int32", "type": "integer" }, "granularity": { "enum": [ "ALL_TIME_GRANULARITY", "GDC.time.year", "GDC.time.week_us", "GDC.time.week_in_year", "GDC.time.week_in_quarter", "GDC.time.week", "GDC.time.euweek_in_year", "GDC.time.euweek_in_quarter", "GDC.time.quarter", "GDC.time.quarter_in_year", "GDC.time.month", "GDC.time.month_in_quarter", "GDC.time.month_in_year", "GDC.time.day_in_year", "GDC.time.day_in_quarter", "GDC.time.day_in_month", "GDC.time.day_in_week", "GDC.time.day_in_euweek", "GDC.time.date", "GDC.time.hour", "GDC.time.hour_in_day", "GDC.time.minute", "GDC.time.minute_in_hour", "GDC.time.fiscal_month", "GDC.time.fiscal_quarter", "GDC.time.fiscal_year" ], "type": "string" }, "to": { "format": "int32", "type": "integer" } }, "required": [ "granularity" ], "type": "object" }, "RelativeCondition": { "additionalProperties": false, "properties": { "relative": { "$ref": "#/components/schemas/Relative", "description": "Relative (metric-to-metric) condition." } }, "required": [ "relative" ], "title": "RelativeCondition", "type": "object" }, "RelativeConditionOperator": { "description": "Operator of a relative (metric-to-metric) condition.", "enum": [ "INCREASES_BY", "DECREASES_BY", "CHANGES_BY" ], "title": "RelativeConditionOperator", "type": "string" }, "RelativeDateFilter": { "description": "A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension. The 'from' and 'to' properties mark the boundaries of the interval. If 'from' is omitted, all values earlier than 'to' are included. If 'to' is omitted, all values later than 'from' are included. It is not allowed to omit both.", "properties": { "relativeDateFilter": { "properties": { "applyOnResult": { "type": "boolean" }, "boundedFilter": { "$ref": "#/components/schemas/BoundedFilter" }, "dataset": { "$ref": "#/components/schemas/AfmObjectIdentifierDataset" }, "emptyValueHandling": { "default": "EXCLUDE", "description": "Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates.", "enum": [ "INCLUDE", "EXCLUDE", "ONLY" ], "type": "string" }, "from": { "description": "Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for '2 days/weeks, ... ago').", "example": -6, "format": "int32", "type": "integer" }, "granularity": { "description": "Date granularity specifying particular date attribute in given dimension.", "enum": [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR" ], "example": "DAY", "type": "string" }, "localIdentifier": { "type": "string" }, "to": { "description": "End of the filtering interval. Specified by number of periods (with respect to given granularity). Value 'O' is representing current time-interval (current day, week, ...).", "example": 0, "format": "int32", "type": "integer" } }, "required": [ "dataset", "from", "granularity", "to" ], "type": "object" } }, "required": [ "relativeDateFilter" ], "type": "object" }, "RelativeDateFilter-Input": { "additionalProperties": false, "properties": { "relativeDateFilter": { "$ref": "#/components/schemas/RelativeDateFilterBody-Input" } }, "required": [ "relativeDateFilter" ], "title": "RelativeDateFilter", "type": "object" }, "RelativeDateFilter-Output": { "additionalProperties": false, "properties": { "relativeDateFilter": { "$ref": "#/components/schemas/RelativeDateFilterBody-Output" } }, "required": [ "relativeDateFilter" ], "title": "RelativeDateFilter", "type": "object" }, "RelativeDateFilterBody-Input": { "additionalProperties": false, "properties": { "applyOnResult": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Applyonresult" }, "boundedFilter": { "anyOf": [ { "$ref": "#/components/schemas/BoundedFilter-Input" }, { "type": "null" } ] }, "dataset": { "$ref": "#/components/schemas/AfmObjectIdentifier" }, "emptyValueHandling": { "anyOf": [ { "$ref": "#/components/schemas/EmptyValueHandling" }, { "type": "null" } ] }, "from": { "title": "From", "type": "integer" }, "granularity": { "$ref": "#/components/schemas/DateGranularity-Input" }, "localIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Localidentifier" }, "to": { "title": "To", "type": "integer" } }, "required": [ "dataset", "granularity", "from", "to" ], "title": "RelativeDateFilterBody", "type": "object" }, "RelativeDateFilterBody-Output": { "additionalProperties": false, "properties": { "applyOnResult": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Applyonresult" }, "boundedFilter": { "anyOf": [ { "$ref": "#/components/schemas/BoundedFilter-Output" }, { "type": "null" } ] }, "dataset": { "$ref": "#/components/schemas/AfmObjectIdentifier" }, "emptyValueHandling": { "anyOf": [ { "$ref": "#/components/schemas/EmptyValueHandling" }, { "type": "null" } ] }, "from": { "title": "From", "type": "integer" }, "granularity": { "$ref": "#/components/schemas/app__application__dtos__afm__filter_definition__DateGranularity" }, "localIdentifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Localidentifier" }, "to": { "title": "To", "type": "integer" } }, "required": [ "dataset", "granularity", "from", "to" ], "title": "RelativeDateFilterBody", "type": "object" }, "RelativeWrapper": { "properties": { "relative": { "$ref": "#/components/schemas/Relative" } }, "required": [ "relative" ], "type": "object" }, "RemoveDatabaseDataSourceResponse": { "description": "Confirmation of data source removal from an AI Lake Database instance", "properties": { "dataSourceId": { "description": "Identifier of the removed data source in metadata-api.", "type": "string" } }, "required": [ "dataSourceId" ], "type": "object" }, "ResolveSettingsRequest": { "description": "A request containing setting IDs to resolve.", "properties": { "settings": { "description": "An array of setting IDs to resolve.", "example": [ "timezone" ], "items": { "type": "string" }, "type": "array" } }, "required": [ "settings" ], "type": "object" }, "ResolvedLlm": { "description": "The resolved LLM configuration, or null if none is configured.", "properties": { "id": { "type": "string" }, "title": { "type": "string" } }, "required": [ "id", "title" ], "type": "object" }, "ResolvedLlmProvider": { "allOf": [ { "$ref": "#/components/schemas/ResolvedLlm" }, { "properties": { "id": { "description": "Provider Id", "type": "string" }, "models": { "items": { "$ref": "#/components/schemas/LlmModel" }, "maxItems": 1, "minItems": 1, "type": "array" }, "title": { "description": "Provider Title", "type": "string" } }, "type": "object" } ], "required": [ "id", "models", "title" ], "type": "object" }, "ResolvedLlms": { "properties": { "data": { "oneOf": [ { "$ref": "#/components/schemas/ResolvedLlmProvider" } ] } }, "type": "object" }, "ResolvedSetting": { "description": "Setting and its value.", "properties": { "content": { "$ref": "#/components/schemas/JsonNode" }, "id": { "deprecated": true, "description": "Setting ID. Formerly used to identify a type of a particular setting, going to be removed in a favor of setting's type.", "type": "string" }, "type": { "description": "Type of the setting.", "enum": [ "TIMEZONE", "ACTIVE_THEME", "ACTIVE_COLOR_PALETTE", "ACTIVE_LLM_PROVIDER", "ACTIVE_CALENDARS", "WHITE_LABELING", "LOCALE", "METADATA_LOCALE", "FORMAT_LOCALE", "MAPBOX_TOKEN", "GEO_ICON_SHEET", "AG_GRID_TOKEN", "WEEK_START", "FISCAL_YEAR", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", "TIMEZONE_VALIDATION_ENABLED", "OPENAI_CONFIG", "ENABLE_FILE_ANALYTICS", "ALERT", "SEPARATORS", "DATE_FILTER_CONFIG", "JIT_PROVISIONING", "JWT_JIT_PROVISIONING", "DASHBOARD_FILTERS_APPLY_MODE", "ENABLE_SLIDES_EXPORT", "ENABLE_SNAPSHOT_EXPORT", "AI_RATE_LIMIT", "ATTACHMENT_SIZE_LIMIT", "ATTACHMENT_LINK_TTL", "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE", "ENABLE_DRILL_TO_URL_BY_DEFAULT", "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS", "ENABLE_AUTOMATION_EVALUATION_MODE", "ENABLE_ACCESSIBILITY_MODE", "REGISTERED_PLUGGABLE_APPLICATIONS", "DATA_LOCALE", "LDM_DEFAULT_LOCALE", "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS", "MAX_ZOOM_LEVEL", "SORT_CASE_SENSITIVE", "SORT_COLLATION", "METRIC_FORMAT_OVERRIDE", "ENABLE_AI_ON_DATA", "ENABLE_PARTIAL_DATA_RESULTS", "API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE", "EXPORT_CSV_CUSTOM_DELIMITER", "ENABLE_QUERY_TAGS", "RESTRICT_BASE_UI", "CERTIFY_PARENT_OBJECTS", "HLL_TYPE" ], "example": "TIMEZONE", "type": "string" } }, "required": [ "id" ], "type": "object" }, "ResponseFeedback": { "properties": { "text": { "anyOf": [ { "maxLength": 2000, "type": "string" }, { "type": "null" } ], "title": "Text" }, "type": { "enum": [ "POSITIVE", "NEGATIVE" ], "title": "Type", "type": "string" } }, "required": [ "type" ], "title": "ResponseFeedback", "type": "object" }, "ResponseFeedbackRequest": { "properties": { "feedback": { "anyOf": [ { "$ref": "#/components/schemas/ResponseFeedback" }, { "type": "null" } ] } }, "required": [ "feedback" ], "title": "ResponseFeedbackRequest", "type": "object" }, "RestApiIdentifier": { "description": "Object identifier.", "properties": { "id": { "example": "sample_item.price", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "example": "fact", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "ResultCacheMetadata": { "description": "All execution result's metadata used for calculation including ExecutionResponse", "properties": { "afm": { "$ref": "#/components/schemas/AFM" }, "executionResponse": { "$ref": "#/components/schemas/ExecutionResponse" }, "resultSize": { "format": "int64", "type": "integer" }, "resultSpec": { "$ref": "#/components/schemas/ResultSpec" } }, "required": [ "afm", "executionResponse", "resultSize", "resultSpec" ], "type": "object" }, "ResultDimension": { "description": "Single result dimension", "properties": { "headers": { "items": { "$ref": "#/components/schemas/ResultDimensionHeader" }, "type": "array" }, "localIdentifier": { "description": "Local identifier of the dimension.", "type": "string" } }, "required": [ "headers", "localIdentifier" ], "type": "object" }, "ResultDimensionHeader": { "description": "One of the headers in a result dimension.", "oneOf": [ { "$ref": "#/components/schemas/MeasureGroupHeaders" }, { "$ref": "#/components/schemas/AttributeHeader" } ], "type": "object" }, "ResultSpec": { "description": "Specifies how the result data will be formatted (```dimensions```) and which additional data shall be computed (```totals```).", "properties": { "dimensions": { "items": { "$ref": "#/components/schemas/Dimension" }, "type": "array" }, "totals": { "items": { "$ref": "#/components/schemas/Total" }, "type": "array" } }, "required": [ "dimensions" ], "type": "object" }, "RichTextWidgetDescriptor": { "description": "Rich text widget displaying static content. Has no execution result.", "properties": { "content": { "description": "Markdown/text content of the rich text widget.", "type": "string" }, "filters": { "description": "Filters currently applied to the dashboard.", "items": { "$ref": "#/components/schemas/FilterDefinition" }, "type": "array" }, "title": { "description": "Widget title as displayed on the dashboard.", "type": "string" }, "widgetId": { "description": "Widget object ID.", "type": "string" } }, "required": [ "title", "widgetId" ], "type": "object" }, "RouteResult": { "description": "Question -> Use Case routing. May contain final answer is a special use case is not required.", "properties": { "reasoning": { "description": "Explanation why LLM picked this use case.", "type": "string" }, "useCase": { "description": "Use case where LLM routed based on question.", "enum": [ "INVALID", "GENERAL", "SEARCH", "CREATE_VISUALIZATION", "EXTEND_VISUALIZATION", "HOWTO", "CHANGE_ANALYSIS", "ALERT" ], "type": "string" } }, "required": [ "reasoning", "useCase" ], "type": "object" }, "RsaSpecification": { "properties": { "alg": { "enum": [ "RS256", "RS384", "RS512" ], "type": "string" }, "e": { "type": "string" }, "kid": { "maxLength": 255, "pattern": "^[^.]", "type": "string" }, "kty": { "enum": [ "RSA" ], "type": "string" }, "n": { "type": "string" }, "use": { "enum": [ "sig" ], "type": "string" }, "x5c": { "items": { "type": "string" }, "type": "array" }, "x5t": { "type": "string" } }, "required": [ "alg", "e", "kid", "kty", "n", "use" ], "type": "object" }, "RulePermission": { "description": "List of rules", "properties": { "permissions": { "description": "Permissions granted by the rule", "items": { "$ref": "#/components/schemas/GrantedPermission" }, "type": "array" }, "type": { "description": "Type of the rule", "example": "allWorkspaceUsers", "type": "string" } }, "required": [ "type" ], "type": "object" }, "RunServiceCommandRequest": { "description": "Request to run an AI Lake Service Command", "properties": { "context": { "additionalProperties": { "description": "The context to pass to the command", "nullable": true, "type": "string" }, "description": "The context to pass to the command", "nullable": true, "type": "object" }, "payload": { "$ref": "#/components/schemas/JsonNode" } }, "type": "object" }, "RunningSection": { "description": "Footer section of the slide", "nullable": true, "properties": { "left": { "description": "Either {{logo}} variable or custom text with combination of other variables.", "nullable": true, "type": "string" }, "right": { "description": "Either {{logo}} variable or custom text with combination of other variables.", "nullable": true, "type": "string" } }, "type": "object" }, "SavedVisualization": { "description": "Created and saved visualization IDs.", "properties": { "createdVisualizationId": { "description": "Created visualization ID.", "type": "string" }, "savedVisualizationId": { "description": "Saved visualization ID.", "type": "string" } }, "required": [ "createdVisualizationId", "savedVisualizationId" ], "type": "object" }, "ScanRequest": { "description": "A request containing all information critical to model scanning.", "properties": { "scanTables": { "description": "A flag indicating whether the tables should be scanned.", "example": true, "type": "boolean" }, "scanViews": { "description": "A flag indicating whether the views should be scanned.", "example": true, "type": "boolean" }, "schemata": { "description": "What schemata will be scanned.", "example": [ "tpch", "demo" ], "items": { "type": "string" }, "type": "array" }, "separator": { "description": "A separator between prefixes and the names.", "example": "__", "type": "string" }, "tablePrefix": { "description": "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.", "example": "out_table", "type": "string" }, "viewPrefix": { "description": "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.", "example": "out_view", "type": "string" } }, "required": [ "scanTables", "scanViews", "separator" ], "type": "object" }, "ScanResultPdm": { "description": "Result of scan of data source physical model.", "properties": { "pdm": { "$ref": "#/components/schemas/DeclarativeTables" }, "warnings": { "items": { "$ref": "#/components/schemas/TableWarning" }, "type": "array" } }, "required": [ "pdm", "warnings" ], "type": "object" }, "ScanSqlRequest": { "description": "A request with SQL query to by analyzed.", "properties": { "sql": { "description": "SQL query to be analyzed.", "example": "SELECT a.special_value as result FROM tableA a", "type": "string" } }, "required": [ "sql" ], "type": "object" }, "ScanSqlResponse": { "description": "Result of scanSql. Consists of array of query columns including type. Sql query result data preview can be attached optionally", "properties": { "columns": { "description": "Array of columns with types.", "items": { "$ref": "#/components/schemas/SqlColumn" }, "type": "array" }, "dataPreview": { "description": "Array of rows where each row is another array of string values.", "items": { "items": { "nullable": true, "type": "string" }, "type": "array" }, "type": "array" } }, "required": [ "columns" ], "type": "object" }, "SearchObject": { "additionalProperties": false, "properties": { "createdAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Object creation timestamp.", "title": "Createdat" }, "datasetId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Parent dataset ID.", "title": "Datasetid" }, "datasetTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Parent dataset title.", "title": "Datasettitle" }, "datasetType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Parent dataset type.", "title": "Datasettype" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Object description.", "title": "Description" }, "id": { "description": "Object identifier.", "title": "Id", "type": "string" }, "isHidden": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether object is hidden.", "title": "Ishidden" }, "modifiedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Object modification timestamp.", "title": "Modifiedat" }, "score": { "description": "Search relevance score.", "title": "Score", "type": "number" }, "tags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "description": "Object tags.", "title": "Tags" }, "title": { "description": "Object title.", "title": "Title", "type": "string" }, "type": { "description": "Object type name.", "title": "Type", "type": "string" }, "visualizationUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Visualization URL when applicable.", "title": "Visualizationurl" }, "workspaceId": { "description": "Workspace identifier.", "title": "Workspaceid", "type": "string" } }, "required": [ "id", "type", "workspaceId", "title", "score" ], "title": "SearchObject", "type": "object" }, "SearchRelationship": { "additionalProperties": false, "properties": { "sourceId": { "description": "Source object identifier.", "title": "Sourceid", "type": "string" }, "sourceTitle": { "description": "Source object title.", "title": "Sourcetitle", "type": "string" }, "sourceType": { "description": "Source object type.", "title": "Sourcetype", "type": "string" }, "sourceWorkspaceId": { "description": "Workspace ID of the source object.", "title": "Sourceworkspaceid", "type": "string" }, "targetId": { "description": "Target object identifier.", "title": "Targetid", "type": "string" }, "targetTitle": { "description": "Target object title.", "title": "Targettitle", "type": "string" }, "targetType": { "description": "Target object type.", "title": "Targettype", "type": "string" }, "targetWorkspaceId": { "description": "Workspace ID of the target object.", "title": "Targetworkspaceid", "type": "string" } }, "required": [ "sourceWorkspaceId", "sourceId", "sourceType", "sourceTitle", "targetWorkspaceId", "targetId", "targetType", "targetTitle" ], "title": "SearchRelationship", "type": "object" }, "SearchRelationshipObject": { "properties": { "sourceObjectId": { "description": "Source object ID.", "type": "string" }, "sourceObjectTitle": { "description": "Source object title.", "type": "string" }, "sourceObjectType": { "description": "Source object type, e.g. dashboard.", "type": "string" }, "sourceWorkspaceId": { "description": "Source workspace ID. If relationship is dashboard->visualization, this is the workspace where the dashboard is located.", "type": "string" }, "targetObjectId": { "description": "Target object ID.", "type": "string" }, "targetObjectTitle": { "description": "Target object title.", "type": "string" }, "targetObjectType": { "description": "Target object type, e.g. visualization.", "type": "string" }, "targetWorkspaceId": { "description": "Target workspace ID. If relationship is dashboard->visualization, this is the workspace where the visualization is located.", "type": "string" } }, "required": [ "sourceObjectId", "sourceObjectTitle", "sourceObjectType", "sourceWorkspaceId", "targetObjectId", "targetObjectTitle", "targetObjectType", "targetWorkspaceId" ], "type": "object" }, "SearchRequest": { "properties": { "allowedRelationshipTypes": { "description": "Filter relationships and results based on allowed relationship type combinations. When specified, only relationships matching the allowed types are returned, and results are filtered to include only direct matches or objects reachable via allowed relationships. When null or omitted, all relationships and results are returned (default behavior). Note: This filtering happens after the initial search, so the number of returned results may be lower than the requested limit if some results are filtered out.", "items": { "$ref": "#/components/schemas/AllowedRelationshipType" }, "type": "array" }, "deepSearch": { "default": false, "description": "Turn on deep search. If true, content of complex objects will be searched as well, e.g. metrics in visualizations.", "type": "boolean" }, "enableHybridSearch": { "default": false, "description": "If true, enables hybrid search combining vector similarity and keyword matching. This can improve search results by considering both semantic similarity and exact keyword matches.", "type": "boolean" }, "excludeTags": { "description": "Exclude objects that contain any of the specified tags. This parameter only affects the search results. Objects with excluded tags are completely hidden from the results.", "items": { "description": "Tag to exclude.", "type": "string" }, "type": "array" }, "includeHidden": { "default": false, "description": "If true, includes hidden objects in search results. If false (default), excludes objects where isHidden=true.", "type": "boolean" }, "includeTags": { "description": "Include only objects that contain at least one of the specified tags (OR logic). This parameter only affects the search results. If an object has multiple tags, it will be included as long as it matches at least one tag from this parameter.", "items": { "description": "Tag to include.", "type": "string" }, "type": "array" }, "limit": { "default": 10, "description": "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. This can happen when post-search filters are applied (e.g., reranker threshold filtering or allowedRelationshipTypes filtering), which may exclude some results after the initial search.", "format": "int32", "type": "integer" }, "objectTypes": { "description": "List of object types to search for.", "items": { "description": "Object type to search for.", "enum": [ "attribute", "metric", "fact", "label", "date", "dataset", "visualization", "dashboard" ], "type": "string" }, "type": "array" }, "question": { "description": "Keyword/sentence is input for search.", "maxLength": 1000, "type": "string" }, "relevantScoreThreshold": { "default": 0.3, "description": "Score, above which we return found objects. Below this score objects are not relevant.", "format": "double", "type": "number" }, "titleToDescriptorRatio": { "default": 0.7, "description": "Temporary for experiments. Ratio of title score to descriptor score.", "format": "double", "type": "number" } }, "required": [ "question" ], "type": "object" }, "SearchResult": { "properties": { "error": { "$ref": "#/components/schemas/ErrorInfo" }, "reasoning": { "description": "DEPRECATED: Use top-level reasoning.steps instead. If something is not working properly this field will contain explanation.", "type": "string" }, "relationships": { "items": { "$ref": "#/components/schemas/SearchRelationshipObject" }, "type": "array" }, "results": { "items": { "$ref": "#/components/schemas/SearchResultObject" }, "type": "array" } }, "required": [ "reasoning", "relationships", "results" ], "type": "object" }, "SearchResultObject": { "properties": { "createdAt": { "description": "Timestamp when object was created.", "format": "date-time", "type": "string" }, "description": { "description": "Object description.", "type": "string" }, "id": { "description": "Object ID.", "type": "string" }, "isHidden": { "description": "If true, this object is hidden from AI search results by default.", "type": "boolean" }, "modifiedAt": { "description": "Timestamp when object was last modified.", "format": "date-time", "type": "string" }, "score": { "description": "Result score calculated by a similarity search algorithm (cosine_distance).", "format": "float", "type": "number" }, "scoreDescriptor": { "description": "Result score for descriptor containing(now) description and tags.", "format": "float", "type": "number" }, "scoreExactMatch": { "description": "Result score for exact match(id/title). 1/1000. Other scores are multiplied by this.", "format": "int32", "type": "integer" }, "scoreTitle": { "description": "Result score for object title.", "format": "float", "type": "number" }, "tags": { "items": { "description": "List of tags assigned to the object.", "type": "string" }, "type": "array", "uniqueItems": true }, "title": { "description": "Object title.", "type": "string" }, "type": { "description": "Object type, e.g. dashboard.", "type": "string" }, "visualizationUrl": { "description": "If the object is visualization, this field defines the type of visualization.", "type": "string" }, "workspaceId": { "description": "Workspace ID.", "type": "string" } }, "required": [ "id", "title", "type", "workspaceId" ], "type": "object" }, "SearchResults": { "additionalProperties": false, "properties": { "keywords": { "description": "Keywords used in search query.", "items": { "type": "string" }, "title": "Keywords", "type": "array" }, "objects": { "description": "Search result objects for widget rendering.", "items": { "$ref": "#/components/schemas/SearchObject" }, "title": "Objects", "type": "array" }, "relationships": { "anyOf": [ { "items": { "$ref": "#/components/schemas/SearchRelationship" }, "type": "array" }, { "type": "null" } ], "description": "Parent-child relationships among returned objects.", "title": "Relationships" }, "requestedObjectType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Primary requested object type.", "title": "Requestedobjecttype" }, "type": { "const": "searchResults", "default": "searchResults", "description": "Type of multipart part.", "title": "Type", "type": "string" } }, "required": [ "objects", "keywords" ], "title": "SearchResults", "type": "object" }, "SectionSlideTemplate": { "description": "Settings for section slide.", "nullable": true, "properties": { "backgroundImage": { "default": true, "description": "Show background image on the slide.", "type": "boolean" }, "footer": { "$ref": "#/components/schemas/RunningSection" }, "header": { "$ref": "#/components/schemas/RunningSection" } }, "type": "object" }, "SendMessageContent": { "properties": { "text": { "title": "Text", "type": "string" }, "type": { "const": "text", "title": "Type", "type": "string" } }, "required": [ "type", "text" ], "title": "SendMessageContent", "type": "object" }, "SendMessageItem": { "properties": { "content": { "$ref": "#/components/schemas/SendMessageContent" }, "role": { "const": "user", "title": "Role", "type": "string" } }, "required": [ "role", "content" ], "title": "SendMessageItem", "type": "object" }, "SendMessageOptions": { "properties": { "search": { "anyOf": [ { "$ref": "#/components/schemas/SendMessageSearchOptions" }, { "type": "null" } ] } }, "title": "SendMessageOptions", "type": "object" }, "SendMessageRequest": { "description": "POST /conversations/{conversationId}/messages body.", "properties": { "item": { "$ref": "#/components/schemas/SendMessageItem" }, "options": { "anyOf": [ { "$ref": "#/components/schemas/SendMessageOptions" }, { "type": "null" } ] }, "userContext": { "anyOf": [ { "$ref": "#/components/schemas/UserContext" }, { "type": "null" } ] } }, "required": [ "item" ], "title": "SendMessageRequest", "type": "object" }, "SendMessageSearchOptions": { "properties": { "allowedRelationshipTypes": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AllowedRelationshipType" }, "type": "array" }, { "type": "null" } ], "title": "Allowedrelationshiptypes" }, "excludeTags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Excludetags" }, "includeTags": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Includetags" }, "objectTypes": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ObjectType" }, "type": "array" }, { "type": "null" } ], "title": "Objecttypes" }, "searchLimit": { "anyOf": [ { "maximum": 100.0, "minimum": 1.0, "type": "integer" }, { "type": "null" } ], "title": "Searchlimit" } }, "title": "SendMessageSearchOptions", "type": "object" }, "Sensitivity": { "description": "Sensitivity level for anomaly detection.", "enum": [ "LOW", "MEDIUM", "HIGH" ], "title": "Sensitivity", "type": "string" }, "ServerSentEventChatResult": { "type": "object" }, "ServiceInfo": { "description": "Non-sensitive metadata for an AI Lake pipeline", "properties": { "name": { "description": "Human-readable name of the service", "type": "string" }, "serviceId": { "description": "Internal identifier for the service configuration (UUID)", "type": "string" } }, "required": [ "name", "serviceId" ], "type": "object" }, "SetCertificationRequest": { "description": "Request to set or clear the certification of a workspace entity.", "properties": { "id": { "description": "ID of the entity.", "example": "total-sales", "type": "string" }, "message": { "description": "Optional message associated with the certification.", "nullable": true, "type": "string" }, "status": { "description": "Certification status of the entity.", "enum": [ "CERTIFIED" ], "nullable": true, "type": "string" }, "type": { "description": "Type of the entity.", "enum": [ "metric", "visualizationObject", "analyticalDashboard" ], "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "Settings": { "description": "Additional settings.", "properties": { "delimiter": { "description": "Set column delimiter. (CSV)", "maxLength": 1, "minLength": 1, "pattern": "^[\\t !#$%&()*+\\-.,/:;<=>?@\\[\\\\\\]^_{|}~]$", "type": "string" }, "exportInfo": { "default": false, "description": "If true, the export will contain the information about the export \u2013 exported date, filters, etc. Works only with `visualizationObject`. (XLSX, PDF)", "example": true, "type": "boolean" }, "grandTotalsPosition": { "description": "Grand totals position. Takes precedence over position specified in visualization.", "enum": [ "pinnedBottom", "pinnedTop", "bottom", "top" ], "type": "string" }, "mergeHeaders": { "description": "Merge equal headers in neighbouring cells. (XLSX)", "example": true, "type": "boolean" }, "pageOrientation": { "default": "PORTRAIT", "description": "Set page orientation. (PDF)", "enum": [ "PORTRAIT", "LANDSCAPE" ], "type": "string" }, "pageSize": { "default": "A4", "description": "Set page size. (PDF)", "enum": [ "A3", "A4", "LETTER" ], "type": "string" }, "pdfPageSize": { "deprecated": true, "description": "Page size and orientation. (PDF)", "example": "a4 landscape", "type": "string" }, "pdfTableStyle": { "deprecated": true, "description": "Custom CSS styles for the table. (PDF, HTML)", "example": [ { "properties": [ { "key": "font-size", "value": "30px" } ], "selector": "th" } ], "items": { "$ref": "#/components/schemas/PdfTableStyle" }, "type": "array" }, "pdfTopLeftContent": { "deprecated": true, "description": "Top left header content. (PDF)", "example": "Good", "type": "string" }, "pdfTopRightContent": { "deprecated": true, "description": "Top right header content. (PDF)", "example": "Morning", "type": "string" }, "showFilters": { "deprecated": true, "description": "Print applied filters on top of the document. (PDF/HTML when visualizationObject is given)", "example": false, "type": "boolean" } }, "type": "object" }, "SimpleMeasureDefinition": { "description": "Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.", "properties": { "measure": { "properties": { "aggregation": { "description": "Definition of aggregation type of the metric.", "enum": [ "SUM", "COUNT", "AVG", "MIN", "MAX", "MEDIAN", "RUNSUM", "APPROXIMATE_COUNT" ], "example": "SUM", "type": "string" }, "computeRatio": { "default": false, "description": "If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).", "example": true, "type": "boolean" }, "filters": { "description": "Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.", "items": { "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" }, "type": "array" }, "item": { "$ref": "#/components/schemas/AfmObjectIdentifierCore" } }, "required": [ "item" ], "type": "object" } }, "required": [ "measure" ], "type": "object" }, "Skeleton": { "properties": { "content": { "items": { "type": "object" }, "type": "array" }, "href": { "type": "string" } }, "type": "object" }, "SkillResponse": { "description": "A single skill available to the organization.", "properties": { "description": { "title": "Description", "type": "string" }, "examples": { "items": { "type": "string" }, "title": "Examples", "type": "array" }, "name": { "title": "Name", "type": "string" }, "tags": { "items": { "type": "string" }, "title": "Tags", "type": "array" }, "title": { "title": "Title", "type": "string" } }, "required": [ "name", "title", "description", "tags", "examples" ], "title": "SkillResponse", "type": "object" }, "SlidesExportRequest": { "description": "Export request object describing the export properties and metadata for slides exports.", "properties": { "dashboardId": { "description": "Dashboard identifier", "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", "type": "string" }, "fileName": { "description": "File name to be used for retrieving the pdf document.", "example": "filename", "type": "string" }, "format": { "description": "Requested resulting file type.", "enum": [ "PDF", "PPTX" ], "example": "PDF", "type": "string" }, "metadata": { "$ref": "#/components/schemas/JsonNode" }, "templateId": { "description": "Export template identifier.", "maxLength": 255, "nullable": true, "type": "string" }, "visualizationIds": { "description": "List of visualization ids to be exported. Note that only one visualization is currently supported.", "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "maxItems": 1, "type": "array", "uniqueItems": true }, "widgetIds": { "description": "List of widget identifiers to be exported. Note that only one widget is currently supported.", "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "maxItems": 1, "type": "array", "uniqueItems": true } }, "required": [ "fileName", "format" ], "type": "object" }, "SmartFunctionResponse": { "properties": { "links": { "$ref": "#/components/schemas/ExecutionLinks" } }, "required": [ "links" ], "type": "object" }, "Smtp": { "allOf": [ { "properties": { "fromEmail": { "default": "no-reply@gooddata.com", "description": "E-mail address to send notifications from.", "format": "email", "type": "string" }, "fromEmailName": { "default": "GoodData", "description": "An optional e-mail name to send notifications from.", "type": "string" }, "host": { "description": "The SMTP server address.", "type": "string" }, "password": { "description": "The SMTP server password.", "type": "string", "writeOnly": true }, "port": { "description": "The SMTP server port.", "enum": [ 25, 465, 587, 2525 ], "format": "int32", "type": "integer" }, "type": { "description": "The destination type.", "enum": [ "SMTP" ], "type": "string" }, "username": { "description": "The SMTP server username.", "type": "string" } }, "type": "object" } ], "description": "Custom SMTP destination for notifications. The properties host, port, username, and password are required on create and update", "properties": { "fromEmail": { "default": "no-reply@gooddata.com", "description": "E-mail address to send notifications from.", "format": "email", "type": "string" }, "fromEmailName": { "default": "GoodData", "description": "An optional e-mail name to send notifications from.", "type": "string" }, "host": { "description": "The SMTP server address.", "type": "string" }, "password": { "description": "The SMTP server password.", "type": "string", "writeOnly": true }, "port": { "description": "The SMTP server port.", "enum": [ 25, 465, 587, 2525 ], "format": "int32", "type": "integer" }, "type": { "description": "The destination type.", "enum": [ "SMTP" ], "type": "string" }, "username": { "description": "The SMTP server username.", "type": "string" } }, "required": [ "type" ], "type": "object" }, "SortKey": { "oneOf": [ { "$ref": "#/components/schemas/SortKeyAttribute" }, { "$ref": "#/components/schemas/SortKeyValue" }, { "$ref": "#/components/schemas/SortKeyTotal" } ], "type": "object" }, "SortKeyAttribute": { "description": "Sorting rule for sorting by attribute value in current dimension.", "properties": { "attribute": { "properties": { "attributeIdentifier": { "description": "Item reference (to 'itemIdentifiers') referencing, which item should be used for sorting. Only references to attributes are allowed.", "example": "attribute1", "type": "string" }, "direction": { "description": "Sorting elements - ascending/descending order.", "enum": [ "ASC", "DESC" ], "type": "string" }, "sortType": { "default": "DEFAULT", "description": "Mechanism by which this attribute should be sorted. Available options are:\n- DEFAULT: sorting based on default rules (using sort column if defined, otherwise this label) \n- LABEL: sorting by this label values \n- ATTRIBUTE: sorting by values of this label's attribute (or rather the primary label) \n- ATTRIBUTE: sorting by values of this label's attribute (or rather the primary label)- AREA: sorting by area (total or subtotal) corresponding to each attribute value. The area is computed by summing up all metric values in all other dimensions.", "enum": [ "DEFAULT", "LABEL", "ATTRIBUTE", "AREA" ], "type": "string" } }, "required": [ "attributeIdentifier" ], "type": "object" } }, "required": [ "attribute" ], "type": "object" }, "SortKeyTotal": { "description": "Sorting rule for sorting by total value. DataColumnLocators are only required if there is ambiguity. Locator for measureGroup is taken from the metric of the total.", "properties": { "total": { "properties": { "dataColumnLocators": { "$ref": "#/components/schemas/DataColumnLocators" }, "direction": { "description": "Sorting elements - ascending/descending order.", "enum": [ "ASC", "DESC" ], "type": "string" }, "totalIdentifier": { "description": "Local identifier of the total to sort by.", "type": "string" } }, "required": [ "totalIdentifier" ], "type": "object" } }, "required": [ "total" ], "type": "object" }, "SortKeyValue": { "description": "Sorting rule for sorting by measure value. DataColumnLocators for each dimension opposite to the sorted one must be specified.", "properties": { "value": { "properties": { "dataColumnLocators": { "$ref": "#/components/schemas/DataColumnLocators" }, "direction": { "description": "Sorting elements - ascending/descending order.", "enum": [ "ASC", "DESC" ], "type": "string" } }, "required": [ "dataColumnLocators" ], "type": "object" } }, "required": [ "value" ], "type": "object" }, "SourceReferenceIdentifier": { "description": "A source reference identifier.", "properties": { "id": { "description": "Source reference ID.", "example": "fact_id", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "A type of the reference.", "enum": [ "fact", "attribute" ], "example": "fact", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "SqlColumn": { "description": "A SQL query result column.", "properties": { "dataType": { "description": "Column type", "enum": [ "INT", "STRING", "DATE", "NUMERIC", "TIMESTAMP", "TIMESTAMP_TZ", "BOOLEAN", "HLL" ], "example": "INT", "type": "string" }, "description": { "description": "Column description/comment from database", "example": "Customer unique identifier", "type": "string" }, "name": { "description": "Column name", "example": "customer_id", "type": "string" }, "nullValue": { "description": "Value used as sentinel for null values in the column", "example": "_", "type": "string" } }, "required": [ "dataType", "name" ], "type": "object" }, "SqlQuery": { "allOf": [ { "$ref": "#/components/schemas/ColumnLocation" }, { "properties": { "sql": { "type": "string" } }, "type": "object" } ], "required": [ "sql" ], "type": "object" }, "StaticFeatures": { "description": "Structure for offline feature flag", "properties": { "static": { "allOf": [ { "$ref": "#/components/schemas/Features" }, { "properties": { "items": { "additionalProperties": { "type": "string" }, "type": "object" } }, "type": "object" } ], "required": [ "context", "items" ], "type": "object" } }, "required": [ "static" ], "type": "object" }, "StringConstraints": { "properties": { "maxLength": { "format": "int32", "type": "integer" }, "minLength": { "format": "int32", "type": "integer" } }, "type": "object" }, "StringParameterDefinition": { "properties": { "constraints": { "$ref": "#/components/schemas/StringConstraints" }, "defaultValue": { "type": "string" }, "type": { "description": "The parameter type.", "enum": [ "STRING" ], "type": "string" } }, "required": [ "defaultValue", "type" ], "type": "object" }, "SucceededOperation": { "allOf": [ { "$ref": "#/components/schemas/Operation" }, { "properties": { "result": { "description": "Operation-specific result payload, can be missing for operations like delete", "type": "object" } }, "type": "object" } ], "description": "Operation that has succeeded", "required": [ "id", "kind" ], "type": "object" }, "SuggestedAction": { "additionalProperties": false, "description": "A quick-reply action button rendered alongside the follow-up question.", "properties": { "label": { "description": "Button display text (3-5 words).", "title": "Label", "type": "string" }, "query": { "description": "Exact message sent when the user clicks this action.", "title": "Query", "type": "string" } }, "required": [ "label", "query" ], "title": "SuggestedAction", "type": "object" }, "Suggestion": { "description": "List of suggestions for next steps. Filled when no visualization was created, suggests alternatives.", "properties": { "label": { "description": "Suggestion button label", "type": "string" }, "query": { "description": "Suggestion query", "type": "string" } }, "required": [ "label", "query" ], "type": "object" }, "Suggestions": { "additionalProperties": false, "description": "Follow-up suggestions emitted by the assistant alongside its terminal multipart message.\n\nCarried on the assistant ``MultipartContent`` so suggestions are persisted in\nconversation history and stream on the same SSE event as the response that\nproduced them.", "properties": { "actions": { "description": "Quick-reply action buttons. The first action matches the follow-up question.", "items": { "$ref": "#/components/schemas/SuggestedAction" }, "title": "Actions", "type": "array" }, "followUpQuestion": { "description": "Yes-answerable follow-up question recommending the next step.", "title": "Followupquestion", "type": "string" } }, "required": [ "followUpQuestion", "actions" ], "title": "Suggestions", "type": "object" }, "SummarizeRequest": { "properties": { "dashboardId": { "minLength": 1, "title": "Dashboardid", "type": "string" }, "filterContext": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/PositiveAttributeFilter" }, { "$ref": "#/components/schemas/NegativeAttributeFilter" }, { "$ref": "#/components/schemas/MatchAttributeFilter" }, { "$ref": "#/components/schemas/AbsoluteDateFilter" }, { "$ref": "#/components/schemas/RelativeDateFilter-Input" }, { "$ref": "#/components/schemas/AllTimeDateFilter-Input" }, { "$ref": "#/components/schemas/RankingFilter-Input" }, { "$ref": "#/components/schemas/ComparisonMeasureValueFilter" }, { "$ref": "#/components/schemas/RangeMeasureValueFilter" }, { "$ref": "#/components/schemas/CompoundMeasureValueFilter" }, { "$ref": "#/components/schemas/InlineFilterDefinition" } ] }, "type": "array" }, { "type": "null" } ], "description": "AFM filters in the same shape consumed by the AFM execute endpoint, merged on top of each visualization's stored filters using the type-aware merge rules. Omit or send `null` to fall back to the dashboard's saved filter context. Send `[]` to explicitly apply no request filters.", "title": "Filtercontext" }, "formatHint": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Formathint" }, "tabId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Local identifier of the dashboard tab to summarize. When the dashboard has tabs and `tabId` is omitted, the first tab is used (matching the UI's default tab). A `tabId` that does not match any tab's `localIdentifier` returns 404. Supplying `tabId` for a dashboard without tabs returns 400. When `tabId` is combined with `visualizations`, every supplied visualization must belong to the selected tab; otherwise the request returns 400.", "title": "TabId" }, "visualizations": { "anyOf": [ { "items": { "type": "string" }, "minItems": 1, "type": "array" }, { "type": "null" } ], "title": "Visualizations" } }, "required": [ "dashboardId" ], "title": "SummarizeRequest", "type": "object" }, "SummarizeResponse": { "properties": { "filterContext": { "items": { "oneOf": [ { "$ref": "#/components/schemas/PositiveAttributeFilter" }, { "$ref": "#/components/schemas/NegativeAttributeFilter" }, { "$ref": "#/components/schemas/MatchAttributeFilter" }, { "$ref": "#/components/schemas/AbsoluteDateFilter" }, { "$ref": "#/components/schemas/RelativeDateFilter-Output" }, { "$ref": "#/components/schemas/AllTimeDateFilter-Output" }, { "$ref": "#/components/schemas/app__application__dtos__afm__filter_definition__RankingFilter" }, { "$ref": "#/components/schemas/ComparisonMeasureValueFilter" }, { "$ref": "#/components/schemas/RangeMeasureValueFilter" }, { "$ref": "#/components/schemas/CompoundMeasureValueFilter" }, { "$ref": "#/components/schemas/InlineFilterDefinition" } ] }, "title": "Filtercontext", "type": "array" }, "generatedAt": { "format": "date-time", "title": "Generatedat", "type": "string" }, "summary": { "title": "Summary", "type": "string" }, "tabId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "TabId" }, "visualizationsExcluded": { "items": { "$ref": "#/components/schemas/VisualizationExcludedResponse" }, "title": "Visualizationsexcluded", "type": "array" }, "visualizationsIncluded": { "items": { "$ref": "#/components/schemas/VisualizationIncludedResponse" }, "title": "Visualizationsincluded", "type": "array" } }, "required": [ "summary", "filterContext", "visualizationsIncluded", "visualizationsExcluded", "generatedAt" ], "title": "SummarizeResponse", "type": "object" }, "SwitchAgentRequest": { "description": "POST /conversations/{conversationId}/switchAgent body.", "properties": { "agentId": { "title": "Agentid", "type": "string" } }, "required": [ "agentId" ], "title": "SwitchAgentRequest", "type": "object" }, "SwitchIdentityProviderRequest": { "properties": { "idpId": { "description": "Identity provider ID to set as active for the organization.", "example": "my-idp-123", "type": "string" } }, "required": [ "idpId" ], "type": "object" }, "Table": { "allOf": [ { "$ref": "#/components/schemas/ColumnLocation" }, { "properties": { "tableName": { "type": "string" } }, "type": "object" } ], "required": [ "tableName" ], "type": "object" }, "TableOverride": { "description": "Table override settings.", "properties": { "columns": { "description": "An array of column overrides", "items": { "$ref": "#/components/schemas/ColumnOverride" }, "type": "array" }, "path": { "description": "Path for the table.", "example": [ "schema", "table_name" ], "items": { "type": "string" }, "type": "array" } }, "required": [ "columns", "path" ], "type": "object" }, "TableStatisticsEntry": { "properties": { "columns": { "items": { "$ref": "#/components/schemas/ColumnStatisticsEntry" }, "type": "array" }, "dataSize": { "description": "Total data size of the table in bytes.", "format": "int64", "type": "integer" }, "rowCount": { "description": "Total number of rows in the table.", "format": "int64", "type": "integer" }, "schemaName": { "type": "string" }, "tableName": { "type": "string" } }, "required": [ "columns", "schemaName", "tableName" ], "type": "object" }, "TableStatisticsRequest": { "properties": { "schemata": { "items": { "type": "string" }, "type": "array" }, "tableNames": { "items": { "type": "string" }, "type": "array" } }, "required": [ "schemata" ], "type": "object" }, "TableStatisticsResponse": { "properties": { "tables": { "items": { "$ref": "#/components/schemas/TableStatisticsEntry" }, "type": "array" }, "warnings": { "items": { "$ref": "#/components/schemas/TableStatisticsWarning" }, "type": "array" } }, "required": [ "tables", "warnings" ], "type": "object" }, "TableStatisticsWarning": { "properties": { "message": { "type": "string" }, "tableName": { "type": "string" } }, "required": [ "message" ], "type": "object" }, "TableWarning": { "description": "Warnings related to single table.", "properties": { "columns": { "items": { "$ref": "#/components/schemas/ColumnWarning" }, "type": "array" }, "message": { "description": "Warning message related to the table.", "type": "string" }, "name": { "description": "Table name.", "type": "string" } }, "required": [ "columns", "name" ], "type": "object" }, "TabularExportExecution": { "description": "A single pre-executed layer in a multi-layer tabular export.", "properties": { "customOverride": { "$ref": "#/components/schemas/CustomOverride" }, "executionResult": { "description": "Execution result identifier for this layer.", "example": "ff483727196c9dc862c7fd3a5a84df55c96d61a4", "type": "string" }, "title": { "description": "Layer title used for the exported sheet or file name.", "example": "Pushpins", "type": "string" } }, "required": [ "executionResult" ], "type": "object" }, "TabularExportRequest": { "description": "Export request object describing the export properties and overrides for tabular exports.", "properties": { "customOverride": { "$ref": "#/components/schemas/CustomOverride" }, "executionResult": { "description": "Execution result identifier.", "example": "ff483727196c9dc862c7fd3a5a84df55c96d61a4", "type": "string" }, "executions": { "description": "Pre-executed layers for multi-layer geo visualizations. When provided, this is the canonical source of the exported layers and takes precedence over the top-level executionResult and customOverride, which are ignored. Index 0 is the main layer; each layer carries its own executionResult and customOverride.", "items": { "$ref": "#/components/schemas/TabularExportExecution" }, "type": "array" }, "fileName": { "description": "Filename of downloaded file without extension.", "example": "result", "type": "string" }, "format": { "description": "Expected file format.", "enum": [ "CSV", "XLSX", "HTML", "PDF" ], "example": "CSV", "type": "string" }, "metadata": { "$ref": "#/components/schemas/JsonNode" }, "relatedDashboardId": { "description": "Analytical dashboard identifier. Optional identifier, which informs the system that the export is related to a specific dashboard.", "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", "type": "string" }, "settings": { "$ref": "#/components/schemas/Settings" }, "visualizationObject": { "description": "Visualization object identifier. Alternative to executionResult property.", "example": "f7c359bc-c230-4487-b15b-ad9685bcb537", "type": "string" }, "visualizationObjectCustomFilters": { "description": "Optional custom filters (as array of IFilter objects defined in UI SDK) to be applied when visualizationObject is given. Those filters override the original filters defined in the visualization.", "example": "[{\"negativeAttributeFilter\":{\"displayForm\":{\"identifier\":{\"id\":\"products.category\",\"type\":\"label\"}},\"notIn\":{\"values\":[\"Books\"]}}}]", "items": { "type": "object" }, "type": "array" }, "visualizationObjectCustomParameters": { "description": "Optional custom parameters to be applied when visualizationObject is given. Those parameters override the original parameters defined in the visualization.", "items": { "$ref": "#/components/schemas/ParameterValue" }, "type": "array" } }, "required": [ "fileName", "format" ], "type": "object" }, "TelemetryConfig": { "description": "Telemetry-related configuration.", "properties": { "context": { "$ref": "#/components/schemas/TelemetryContext" }, "services": { "$ref": "#/components/schemas/TelemetryServices" } }, "required": [ "context", "services" ], "type": "object" }, "TelemetryContext": { "description": "The telemetry context.", "properties": { "deploymentId": { "description": "Identification of the deployment.", "type": "string" }, "organizationHash": { "description": "Organization hash.", "type": "string" }, "userHash": { "description": "User hash.", "type": "string" } }, "required": [ "deploymentId", "organizationHash", "userHash" ], "type": "object" }, "TelemetryServices": { "description": "Available telemetry services.", "properties": { "amplitude": { "$ref": "#/components/schemas/AmplitudeService" }, "matomo": { "$ref": "#/components/schemas/MatomoService" }, "openTelemetry": { "$ref": "#/components/schemas/OpenTelemetryService" } }, "type": "object" }, "TestDefinitionRequest": { "description": "A request containing all information for testing data source definition.", "properties": { "authenticationType": { "description": "Type of authentication used to connect to the database. Determines how the supplied credentials are used (e.g. KEY_PAIR, OIDC_PASSTHROUGH).", "enum": [ "USERNAME_PASSWORD", "TOKEN", "KEY_PAIR", "CLIENT_SECRET", "OIDC_PASSTHROUGH" ], "nullable": true, "type": "string" }, "clientId": { "description": "Id for client based authentication for data sources which supports it.", "type": "string" }, "clientSecret": { "description": "Secret for client based authentication for data sources which supports it.", "type": "string" }, "parameters": { "items": { "$ref": "#/components/schemas/DataSourceParameter" }, "type": "array" }, "password": { "description": "Database user password.", "example": "admin123", "type": "string" }, "privateKey": { "description": "Private key for data sources which supports key-pair authentication.", "type": "string" }, "privateKeyPassphrase": { "description": "Passphrase for a encrypted version of a private key.", "type": "string" }, "schema": { "description": "Database schema.", "example": "public", "type": "string" }, "token": { "description": "Secret for token based authentication for data sources which supports it.", "type": "string" }, "type": { "description": "Type of database, where test should connect to.", "enum": [ "POSTGRESQL", "REDSHIFT", "VERTICA", "SNOWFLAKE", "ADS", "BIGQUERY", "MSSQL", "PRESTO", "DREMIO", "DRILL", "GREENPLUM", "AZURESQL", "SYNAPSESQL", "DATABRICKS", "GDSTORAGE", "CLICKHOUSE", "MYSQL", "MARIADB", "ORACLE", "PINOT", "SINGLESTORE", "MOTHERDUCK", "FLEXCONNECT", "STARROCKS", "ATHENA", "MONGODB", "CRATEDB", "AILAKEHOUSE", "DENODO" ], "example": "POSTGRESQL", "type": "string" }, "url": { "description": "URL to database in JDBC format, where test should connect to.", "example": "jdbc:postgresql://localhost:5432/db_name", "type": "string" }, "username": { "description": "Database user name.", "example": "dbadmin", "type": "string" } }, "required": [ "type" ], "type": "object" }, "TestDestinationRequest": { "description": "Request body with notification channel destination to test.", "properties": { "destination": { "oneOf": [ { "$ref": "#/components/schemas/DefaultSmtp" }, { "$ref": "#/components/schemas/InPlatform" }, { "$ref": "#/components/schemas/Smtp" }, { "$ref": "#/components/schemas/Webhook" } ] }, "externalRecipients": { "description": "External recipients of the test result.", "items": { "$ref": "#/components/schemas/AutomationExternalRecipient" }, "maxItems": 1, "nullable": true, "type": "array", "uniqueItems": true } }, "required": [ "destination" ], "type": "object" }, "TestLlmProviderByIdRequest": { "properties": { "models": { "description": "Models overrides.", "items": { "$ref": "#/components/schemas/LlmModel" }, "type": "array" }, "providerConfig": { "oneOf": [ { "$ref": "#/components/schemas/AnthropicProviderConfig" }, { "$ref": "#/components/schemas/AwsBedrockProviderConfig" }, { "$ref": "#/components/schemas/AzureFoundryProviderConfig" }, { "$ref": "#/components/schemas/OpenAIProviderConfig" } ] } }, "type": "object" }, "TestLlmProviderDefinitionRequest": { "properties": { "models": { "description": "Models to test.", "items": { "$ref": "#/components/schemas/LlmModel" }, "type": "array" }, "providerConfig": { "oneOf": [ { "$ref": "#/components/schemas/AnthropicProviderConfig" }, { "$ref": "#/components/schemas/AwsBedrockProviderConfig" }, { "$ref": "#/components/schemas/AzureFoundryProviderConfig" }, { "$ref": "#/components/schemas/OpenAIProviderConfig" } ] } }, "required": [ "providerConfig" ], "type": "object" }, "TestLlmProviderResponse": { "properties": { "modelResults": { "description": "Per-model test results.", "items": { "$ref": "#/components/schemas/ModelTestResult" }, "type": "array" }, "providerMessage": { "description": "Message about the provider connectivity test.", "type": "string" }, "providerReachable": { "description": "Whether the LLM provider is reachable.", "type": "boolean" } }, "required": [ "modelResults", "providerMessage", "providerReachable" ], "type": "object" }, "TestNotification": { "allOf": [ { "$ref": "#/components/schemas/NotificationContent" }, { "properties": { "message": { "type": "string" } }, "type": "object" } ], "required": [ "message" ], "type": "object" }, "TestQueryDuration": { "description": "A structure containing duration of the test queries run on a data source. It is omitted if an error happens.", "properties": { "createCacheTable": { "description": "Field containing duration of a test 'create table as select' query on a datasource. In milliseconds. The field is omitted if a data source doesn't support caching.", "example": 235, "format": "int32", "type": "integer" }, "simpleSelect": { "description": "Field containing duration of a test select query on a data source. In milliseconds.", "example": 562, "format": "int32", "type": "integer" } }, "required": [ "simpleSelect" ], "type": "object" }, "TestRequest": { "description": "A request containing all information for testing existing data source.", "properties": { "authenticationType": { "description": "Type of authentication used to connect to the database. Determines how the supplied credentials are used (e.g. KEY_PAIR, OIDC_PASSTHROUGH).", "enum": [ "USERNAME_PASSWORD", "TOKEN", "KEY_PAIR", "CLIENT_SECRET", "OIDC_PASSTHROUGH" ], "nullable": true, "type": "string" }, "clientId": { "description": "Id for client based authentication for data sources which supports it.", "type": "string" }, "clientSecret": { "description": "Secret for client based authentication for data sources which supports it.", "type": "string" }, "parameters": { "items": { "$ref": "#/components/schemas/DataSourceParameter" }, "type": "array" }, "password": { "description": "Database user password.", "example": "admin123", "type": "string" }, "privateKey": { "description": "Private key for data sources which supports key-pair authentication.", "type": "string" }, "privateKeyPassphrase": { "description": "Passphrase for a encrypted version of a private key.", "type": "string" }, "schema": { "description": "Database schema.", "example": "public", "type": "string" }, "token": { "description": "Secret for token based authentication for data sources which supports it.", "type": "string" }, "url": { "description": "URL to database in JDBC format, where test should connect to.", "example": "jdbc:postgresql://localhost:5432/db_name", "type": "string" }, "username": { "description": "Database user name.", "example": "dbadmin", "type": "string" } }, "type": "object" }, "TestResponse": { "description": "Response from data source testing.", "properties": { "error": { "description": "Field containing more details in case of a failure. Details are available to a privileged user only.", "example": "Connection exception: Failed to initialize pool: FATAL: password authentication failed for user \"user\"", "type": "string" }, "queryDurationMillis": { "$ref": "#/components/schemas/TestQueryDuration" }, "successful": { "description": "A flag indicating whether test passed or not.", "example": true, "type": "boolean" } }, "required": [ "successful" ], "type": "object" }, "TextFilterValue": { "additionalProperties": false, "properties": { "case_sensitive": { "title": "Case Sensitive", "type": "boolean" }, "condition": { "enum": [ "contains", "doesNotContain", "startsWith", "doesNotStartWith", "endsWith", "doesNotEndWith" ], "title": "Condition", "type": "string" }, "display_as": { "title": "Display As", "type": "string" }, "type": { "const": "text_filter", "title": "Type", "type": "string" }, "using": { "title": "Using", "type": "string" }, "value": { "title": "Value", "type": "string" } }, "required": [ "type", "using", "condition", "value" ], "title": "TextFilterValue", "type": "object" }, "TextFilterValues": { "additionalProperties": false, "properties": { "case_sensitive": { "title": "Case Sensitive", "type": "boolean" }, "condition": { "enum": [ "is", "isNot" ], "title": "Condition", "type": "string" }, "display_as": { "title": "Display As", "type": "string" }, "type": { "const": "text_filter", "title": "Type", "type": "string" }, "using": { "title": "Using", "type": "string" }, "values": { "items": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": "Values", "type": "array" } }, "required": [ "type", "using", "condition", "values" ], "title": "TextFilterValues", "type": "object" }, "TextMessageContent": { "additionalProperties": false, "properties": { "text": { "description": "Plain text message content.", "title": "Text", "type": "string" }, "type": { "const": "text", "default": "text", "description": "Type of item content.", "title": "Type", "type": "string" } }, "required": [ "text" ], "title": "TextMessageContent", "type": "object" }, "TextPart": { "additionalProperties": false, "properties": { "text": { "description": "Text fragment.", "title": "Text", "type": "string" }, "type": { "const": "text", "default": "text", "description": "Type of multipart part.", "title": "Type", "type": "string" } }, "required": [ "text" ], "title": "TextPart", "type": "object" }, "Thought": { "description": "Detailed thoughts/messages within this step.", "properties": { "text": { "description": "The text content of this thought.", "type": "string" } }, "required": [ "text" ], "type": "object" }, "TimeSlicePartitionConfig": { "description": "Partition by time_slice() expression.", "properties": { "column": { "description": "Column to partition on.", "type": "string" }, "slices": { "description": "How many units per slice.", "format": "int32", "minimum": 1, "type": "integer" }, "unit": { "description": "Date/time unit for partition granularity", "enum": [ "year", "quarter", "month", "week", "day", "hour", "minute", "second", "millisecond", "microsecond" ], "type": "string" } }, "required": [ "column", "slices", "unit" ], "type": "object" }, "Total": { "description": "Definition of a total. There are two types of totals: grand totals and subtotals. Grand total data will be returned in a separate section of the result structure while subtotals are fully integrated into the main result data. The mechanism for this distinction is automatic and it's described in `TotalDimension`", "properties": { "function": { "description": "Aggregation function to compute the total.", "enum": [ "SUM", "MIN", "MAX", "AVG", "MED", "NAT" ], "example": "SUM", "type": "string" }, "localIdentifier": { "description": "Total identification within this request. Used e.g. in sorting by a total.", "example": "firstTotal", "type": "string" }, "metric": { "description": "The metric for which the total will be computed", "example": "metric_1", "type": "string" }, "totalDimensions": { "items": { "$ref": "#/components/schemas/TotalDimension" }, "type": "array" } }, "required": [ "function", "localIdentifier", "metric", "totalDimensions" ], "type": "object" }, "TotalDimension": { "description": "A list of dimensions across which the total will be computed. Total headers for only these dimensions will be returned in the result.", "properties": { "dimensionIdentifier": { "description": "An identifier of a dimension for which the total will be computed.", "example": "firstDimension", "pattern": "^[.a-zA-Z0-9_-]+$", "type": "string" }, "totalDimensionItems": { "description": "List of dimension items which will be used for total computation. The total is a grand total in this dimension if the list is empty or it includes the first dimension item from the dimension definition, and its data and header will be returned in a separate `ExecutionResultGrandTotal` structure. Otherwise, it is a subtotal and the data will be integrated into the main result.", "example": [ "measureGroup" ], "items": { "type": "string" }, "type": "array" } }, "required": [ "dimensionIdentifier", "totalDimensionItems" ], "type": "object" }, "TotalExecutionResultHeader": { "properties": { "totalHeader": { "$ref": "#/components/schemas/TotalResultHeader" } }, "required": [ "totalHeader" ], "type": "object" }, "TotalResultHeader": { "description": "Header containing the information related to a subtotal.", "properties": { "function": { "type": "string" } }, "required": [ "function" ], "type": "object" }, "TrendingObjectItem": { "description": "Trending analytics catalog objects", "properties": { "createdAt": { "description": "Timestamp when object was created.", "format": "date-time", "type": "string" }, "createdBy": { "description": "ID of the user who created the object.", "type": "string" }, "datasetId": { "description": "ID of the associated dataset, if applicable.", "type": "string" }, "datasetTitle": { "description": "Title of the associated dataset, if applicable.", "type": "string" }, "datasetType": { "description": "Type of the associated dataset, if applicable.", "type": "string" }, "description": { "description": "Object description.", "type": "string" }, "id": { "description": "Object ID.", "type": "string" }, "isHidden": { "description": "If true, this object is hidden from AI search results by default.", "type": "boolean" }, "isHiddenFromKda": { "description": "If true, this object is hidden from KDA.", "type": "boolean" }, "metricType": { "description": "Type of the metric (e.g. MAQL), if applicable.", "type": "string" }, "modifiedAt": { "description": "Timestamp when object was last modified.", "format": "date-time", "type": "string" }, "modifiedBy": { "description": "ID of the user who last modified the object.", "type": "string" }, "tags": { "items": { "description": "Tags assigned to the object.", "type": "string" }, "type": "array" }, "title": { "description": "Object title.", "type": "string" }, "type": { "description": "Object type, e.g. dashboard, visualization, metric.", "type": "string" }, "usageCount": { "description": "Number of times this object has been used/referenced.", "format": "int32", "type": "integer" }, "visualizationUrl": { "description": "URL of the visualization, if applicable.", "type": "string" }, "workspaceId": { "description": "Workspace ID the object belongs to.", "type": "string" } }, "required": [ "id", "tags", "title", "type", "usageCount", "workspaceId" ], "type": "object" }, "TrendingObjectsResult": { "properties": { "objects": { "items": { "$ref": "#/components/schemas/TrendingObjectItem" }, "type": "array" } }, "required": [ "objects" ], "type": "object" }, "TriggerAutomationRequest": { "properties": { "automation": { "$ref": "#/components/schemas/AdHocAutomation" } }, "required": [ "automation" ], "type": "object" }, "TriggerQualityIssuesCalculationResponse": { "properties": { "processId": { "description": "Process ID for tracking the calculation status", "type": "string" }, "status": { "description": "Current status of the calculation", "enum": [ "RUNNING", "COMPLETED", "FAILED", "CANCELLED", "DISABLED" ], "type": "string" } }, "required": [ "processId", "status" ], "type": "object" }, "UIContext": { "description": "Ambient UI state: what the user is currently looking at (dashboard, visible widgets).", "properties": { "dashboard": { "$ref": "#/components/schemas/DashboardContext" } }, "type": "object" }, "UniqueKeyConfig": { "description": "Unique key model \u2014 enforces uniqueness, replaces on conflict.", "properties": { "columns": { "description": "Key columns. Defaults to first inferred column.", "items": { "description": "Key columns. Defaults to first inferred column.", "type": "string" }, "type": "array" } }, "type": "object" }, "Unit": { "type": "object" }, "UpdateDatabaseDataSourceRequest": { "description": "Request to update the data source associated with an AI Lake Database instance", "properties": { "dataSourceId": { "description": "New identifier for the data source in metadata-api. Must be unique within the organization.", "type": "string" }, "dataSourceName": { "description": "New display name for the data source in metadata-api. Defaults to dataSourceId when omitted.", "type": "string" }, "oldDataSourceId": { "description": "Identifier of the existing data source to replace.", "type": "string" } }, "required": [ "dataSourceId", "oldDataSourceId" ], "type": "object" }, "UpdateDatabaseDataSourceResponse": { "description": "Updated data source details for an AI Lake Database instance", "properties": { "dataSourceId": { "description": "New identifier of the data source in metadata-api.", "type": "string" }, "dataSourceName": { "description": "New display name of the data source in metadata-api.", "type": "string" } }, "required": [ "dataSourceId", "dataSourceName" ], "type": "object" }, "UploadFileResponse": { "description": "Information related to the file uploaded to the staging area.", "properties": { "location": { "description": "Location to use when referencing the uploaded file in subsequent requests.", "type": "string" } }, "required": [ "location" ], "type": "object" }, "UploadGeoCollectionFileResponse": { "description": "Information related to the geo collection file uploaded to the staging area.", "properties": { "location": { "description": "Location to use when referencing the uploaded file in subsequent requests.", "type": "string" } }, "required": [ "location" ], "type": "object" }, "UserAssignee": { "description": "List of users", "properties": { "email": { "description": "User email address", "example": "user@example.com", "type": "string" }, "id": { "type": "string" }, "name": { "description": "User name", "example": "John Wick", "type": "string" } }, "required": [ "id" ], "type": "object" }, "UserContext": { "description": "User context with ambient UI state (view) and explicitly referenced objects.", "properties": { "activeObject": { "$ref": "#/components/schemas/ActiveObjectIdentification", "anyOf": [ { "$ref": "#/components/schemas/ActiveObjectIdentification" }, { "type": "null" } ] }, "referencedObjects": { "anyOf": [ { "items": { "$ref": "#/components/schemas/UserContextObjectReferenceGroup" }, "type": "array" }, { "type": "null" } ], "description": "Groups of explicitly referenced objects, each optionally scoped by a context (e.g. a dashboard context with widget references).", "items": { "$ref": "#/components/schemas/ObjectReferenceGroup" }, "title": "Referencedobjects", "type": "array" }, "view": { "$ref": "#/components/schemas/UIContext", "anyOf": [ { "$ref": "#/components/schemas/UserContextView" }, { "type": "null" } ] } }, "title": "UserContext", "type": "object" }, "UserContextDashboard": { "properties": { "filters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/VisualizationFilter" }, "type": "array" }, { "type": "null" } ], "title": "Filters" }, "id": { "title": "Id", "type": "string" }, "widgets": { "items": { "$ref": "#/components/schemas/UserContextWidgetDescriptor" }, "title": "Widgets", "type": "array" } }, "required": [ "id" ], "title": "UserContextDashboard", "type": "object" }, "UserContextInsightWidgetDescriptor": { "properties": { "filters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/VisualizationFilter" }, "type": "array" }, { "type": "null" } ], "title": "Filters" }, "resultId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resultid" }, "title": { "title": "Title", "type": "string" }, "visualizationId": { "title": "Visualizationid", "type": "string" }, "widgetId": { "title": "Widgetid", "type": "string" }, "widgetType": { "const": "insight", "title": "Widgettype", "type": "string" } }, "required": [ "widgetId", "title", "widgetType", "visualizationId" ], "title": "UserContextInsightWidgetDescriptor", "type": "object" }, "UserContextObjectReference": { "properties": { "id": { "title": "Id", "type": "string" }, "type": { "enum": [ "WIDGET", "METRIC", "ATTRIBUTE", "DASHBOARD", "FACT" ], "title": "Type", "type": "string" } }, "required": [ "type", "id" ], "title": "UserContextObjectReference", "type": "object" }, "UserContextObjectReferenceGroup": { "properties": { "context": { "anyOf": [ { "$ref": "#/components/schemas/UserContextObjectReference" }, { "type": "null" } ] }, "objects": { "items": { "$ref": "#/components/schemas/UserContextObjectReference" }, "title": "Objects", "type": "array" } }, "required": [ "objects" ], "title": "UserContextObjectReferenceGroup", "type": "object" }, "UserContextRichTextWidgetDescriptor": { "properties": { "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content" }, "filters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/VisualizationFilter" }, "type": "array" }, { "type": "null" } ], "title": "Filters" }, "title": { "title": "Title", "type": "string" }, "widgetId": { "title": "Widgetid", "type": "string" }, "widgetType": { "const": "richText", "title": "Widgettype", "type": "string" } }, "required": [ "widgetId", "title", "widgetType" ], "title": "UserContextRichTextWidgetDescriptor", "type": "object" }, "UserContextView": { "properties": { "dashboard": { "anyOf": [ { "$ref": "#/components/schemas/UserContextDashboard" }, { "type": "null" } ] } }, "title": "UserContextView", "type": "object" }, "UserContextVisualizationSwitcherWidgetDescriptor": { "properties": { "activeVisualizationId": { "title": "Activevisualizationid", "type": "string" }, "filters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/VisualizationFilter" }, "type": "array" }, { "type": "null" } ], "title": "Filters" }, "resultId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resultid" }, "title": { "title": "Title", "type": "string" }, "visualizationIds": { "items": { "type": "string" }, "title": "Visualizationids", "type": "array" }, "widgetId": { "title": "Widgetid", "type": "string" }, "widgetType": { "const": "visualizationSwitcher", "title": "Widgettype", "type": "string" } }, "required": [ "widgetId", "title", "widgetType", "activeVisualizationId" ], "title": "UserContextVisualizationSwitcherWidgetDescriptor", "type": "object" }, "UserContextWidgetDescriptor": { "anyOf": [ { "$ref": "#/components/schemas/UserContextInsightWidgetDescriptor" }, { "$ref": "#/components/schemas/UserContextRichTextWidgetDescriptor" }, { "$ref": "#/components/schemas/UserContextVisualizationSwitcherWidgetDescriptor" } ] }, "UserGroupAssignee": { "description": "List of user groups", "properties": { "id": { "type": "string" }, "name": { "description": "User group name", "example": "admins", "type": "string" } }, "required": [ "id" ], "type": "object" }, "UserGroupIdentifier": { "description": "A list of groups where user is a member", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "UserGroupPermission": { "description": "List of user groups", "properties": { "id": { "type": "string" }, "name": { "description": "Name of the user group", "example": "admins", "type": "string" }, "permissions": { "description": "Permissions granted to the user group", "items": { "$ref": "#/components/schemas/GrantedPermission" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "UserManagementDataSourcePermissionAssignment": { "description": "Datasource permission assignments for users and userGroups", "properties": { "accessSource": { "description": "How the subject gains access to the data source (DIRECT or GROUP). Absent for direct-only listings.", "enum": [ "DIRECT", "GROUP" ], "readOnly": true, "type": "string" }, "id": { "description": "Id of the datasource", "type": "string" }, "name": { "description": "Name of the datasource", "readOnly": true, "type": "string" }, "permissions": { "items": { "enum": [ "MANAGE", "USE" ], "type": "string" }, "type": "array" } }, "required": [ "id", "permissions" ], "type": "object" }, "UserManagementPermissionAssignments": { "properties": { "dataSources": { "items": { "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" }, "type": "array" }, "workspaces": { "items": { "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" }, "type": "array" } }, "required": [ "dataSources", "workspaces" ], "type": "object" }, "UserManagementUserGroupMember": { "properties": { "id": { "type": "string" }, "name": { "readOnly": true, "type": "string" } }, "required": [ "id" ], "type": "object" }, "UserManagementUserGroupMembers": { "properties": { "members": { "items": { "$ref": "#/components/schemas/UserManagementUserGroupMember" }, "type": "array" } }, "required": [ "members" ], "type": "object" }, "UserManagementUserGroups": { "properties": { "totalCount": { "description": "Total number of groups", "format": "int32", "type": "integer" }, "userGroups": { "items": { "$ref": "#/components/schemas/UserManagementUserGroupsItem" }, "type": "array" } }, "required": [ "totalCount", "userGroups" ], "type": "object" }, "UserManagementUserGroupsItem": { "description": "List of groups", "properties": { "dataSources": { "items": { "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" }, "type": "array" }, "id": { "type": "string" }, "name": { "description": "Group name", "example": "admins", "type": "string" }, "organizationAdmin": { "description": "Is group organization admin", "example": false, "type": "boolean" }, "userCount": { "description": "The number of users belonging to the group", "format": "int32", "type": "integer" }, "workspaces": { "items": { "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" }, "type": "array" } }, "required": [ "dataSources", "id", "organizationAdmin", "userCount", "workspaces" ], "type": "object" }, "UserManagementUsers": { "properties": { "totalCount": { "description": "The total number of users is based on applied filters.", "format": "int32", "type": "integer" }, "users": { "items": { "$ref": "#/components/schemas/UserManagementUsersItem" }, "type": "array" } }, "required": [ "totalCount", "users" ], "type": "object" }, "UserManagementUsersItem": { "description": "List of users", "properties": { "dataSources": { "items": { "$ref": "#/components/schemas/UserManagementDataSourcePermissionAssignment" }, "type": "array" }, "email": { "description": "User email address", "example": "user@example.com", "type": "string" }, "id": { "type": "string" }, "name": { "description": "User name", "example": "John Wick", "type": "string" }, "organizationAdmin": { "description": "Is user organization admin", "example": false, "type": "boolean" }, "systemAccount": { "description": "Is user system account", "example": false, "type": "boolean" }, "userGroups": { "items": { "$ref": "#/components/schemas/UserGroupIdentifier" }, "type": "array" }, "workspaces": { "items": { "$ref": "#/components/schemas/UserManagementWorkspacePermissionAssignment" }, "type": "array" } }, "required": [ "dataSources", "id", "organizationAdmin", "systemAccount", "userGroups", "workspaces" ], "type": "object" }, "UserManagementWorkspacePermissionAssignment": { "description": "Workspace permission assignments for users and userGroups", "properties": { "accessSource": { "description": "How the subject gains access to the workspace (DIRECT, GROUP, HIERARCHY). Absent for direct-only listings.", "enum": [ "DIRECT", "GROUP", "HIERARCHY" ], "readOnly": true, "type": "string" }, "hierarchyPermissions": { "items": { "enum": [ "MANAGE", "ANALYZE", "EXPORT", "EXPORT_TABULAR", "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", "WRITE_KNOWLEDGE_DOCUMENTS", "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "VIEW" ], "type": "string" }, "type": "array" }, "id": { "type": "string" }, "name": { "readOnly": true, "type": "string" }, "permissions": { "items": { "enum": [ "MANAGE", "ANALYZE", "EXPORT", "EXPORT_TABULAR", "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", "WRITE_KNOWLEDGE_DOCUMENTS", "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "VIEW" ], "type": "string" }, "type": "array" } }, "required": [ "hierarchyPermissions", "id", "permissions" ], "type": "object" }, "UserPermission": { "description": "List of users", "properties": { "email": { "description": "User email address", "example": "user@example.com", "type": "string" }, "id": { "type": "string" }, "name": { "description": "Name of user", "example": "John Wick", "type": "string" }, "permissions": { "description": "Permissions granted to the user", "items": { "$ref": "#/components/schemas/GrantedPermission" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "ValidateByItem": { "nullable": true, "properties": { "id": { "description": "Specifies entity used for valid elements computation.", "type": "string" }, "type": { "description": "Specifies entity type which could be label, attribute, fact, or metric.", "pattern": "^(label)|(attribute)|(fact)|(metric)$", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "ValidationError": { "properties": { "ctx": { "title": "Context", "type": "object" }, "input": { "title": "Input" }, "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "title": "Location", "type": "array" }, "msg": { "title": "Message", "type": "string" }, "type": { "title": "Error Type", "type": "string" } }, "required": [ "loc", "msg", "type" ], "title": "ValidationError", "type": "object" }, "Value": { "properties": { "value": { "description": "Value of the alert threshold to compare the metric to.", "example": 1000, "type": "number" } }, "required": [ "value" ], "type": "object" }, "ValueOperand": { "additionalProperties": false, "description": "Literal threshold value.", "properties": { "value": { "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "null" } ], "description": "Value of the alert threshold to compare the metric to.", "title": "Value" } }, "required": [ "value" ], "title": "ValueOperand", "type": "object" }, "VisibleFilter": { "properties": { "isAllTimeDateFilter": { "default": false, "description": "Indicates if the filter is an all-time date filter. Such a filter is not included in report computation, so there is no filter with the same 'localIdentifier' to be found. In such cases, this flag is used to inform the server to not search for the filter in the definitions and include it anyways.", "type": "boolean" }, "localIdentifier": { "type": "string" }, "title": { "type": "string" } }, "type": "object" }, "VisualExportRequest": { "description": "Export request object describing the export properties and metadata for dashboard PDF exports.", "properties": { "dashboardId": { "description": "Dashboard identifier", "example": "761cd28b-3f57-4ac9-bbdc-1c552cc0d1d0", "type": "string" }, "fileName": { "description": "File name to be used for retrieving the pdf document.", "example": "filename", "type": "string" }, "metadata": { "description": "Metadata definition in free-form JSON format.", "example": "{}", "type": "object" } }, "required": [ "dashboardId", "fileName" ], "type": "object" }, "Visualization": { "additionalProperties": false, "properties": { "config": { "$ref": "#/components/schemas/VisualizationConfig" }, "id": { "title": "Id", "type": "string" }, "metrics": { "items": { "anyOf": [ { "type": "string" }, { "$ref": "#/components/schemas/BucketRefObject" } ] }, "title": "Metrics", "type": "array" }, "query": { "$ref": "#/components/schemas/Query" }, "segment_by": { "items": { "anyOf": [ { "type": "string" }, { "$ref": "#/components/schemas/BucketRefObject" } ] }, "title": "Segment By", "type": "array" }, "title": { "title": "Title", "type": "string" }, "type": { "enum": [ "table", "headline_chart", "bar_chart", "column_chart", "line_chart", "pie_chart", "scatter_chart" ], "title": "Type", "type": "string" }, "view_by": { "items": { "anyOf": [ { "type": "string" }, { "$ref": "#/components/schemas/BucketRefObject" } ] }, "title": "View By", "type": "array" } }, "required": [ "type", "id", "query" ], "title": "Visualization", "type": "object" }, "VisualizationAbsoluteDateFilter": { "additionalProperties": false, "properties": { "from": { "title": "From", "type": "string" }, "to": { "title": "To", "type": "string" }, "type": { "const": "date_filter", "title": "Type", "type": "string" }, "using": { "title": "Using", "type": "string" } }, "required": [ "type", "using", "from", "to" ], "title": "VisualizationAbsoluteDateFilter", "type": "object" }, "VisualizationAttributeFilter": { "additionalProperties": false, "properties": { "state": { "$ref": "#/components/schemas/VisualizationAttributeFilterState" }, "type": { "const": "attribute_filter", "title": "Type", "type": "string" }, "using": { "title": "Using", "type": "string" } }, "required": [ "type", "using", "state" ], "title": "VisualizationAttributeFilter", "type": "object" }, "VisualizationAttributeFilterState": { "additionalProperties": false, "properties": { "exclude": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Exclude" }, "include": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Include" } }, "title": "VisualizationAttributeFilterState", "type": "object" }, "VisualizationBottomRankingFilter": { "additionalProperties": false, "properties": { "attribute": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Attribute" }, "bottom": { "title": "Bottom", "type": "integer" }, "type": { "const": "ranking_filter", "title": "Type", "type": "string" }, "using": { "title": "Using", "type": "string" } }, "required": [ "type", "using", "bottom" ], "title": "VisualizationBottomRankingFilter", "type": "object" }, "VisualizationConfig": { "additionalProperties": false, "description": "Visualization config for smart-function rendering.", "properties": { "anomalyDetection": { "$ref": "#/components/schemas/AnomalyDetectionConfig" }, "anomaly_detection_color": { "title": "Anomaly Detection Color", "type": "string" }, "anomaly_detection_enabled": { "title": "Anomaly Detection Enabled", "type": "boolean" }, "anomaly_detection_sensitivity": { "enum": [ "low", "medium", "high" ], "title": "Anomaly Detection Sensitivity", "type": "string" }, "anomaly_detection_size": { "enum": [ "small", "medium", "large" ], "title": "Anomaly Detection Size", "type": "string" }, "clustering": { "$ref": "#/components/schemas/ClusteringConfig" }, "clustering_amount": { "anyOf": [ { "type": "integer" }, { "type": "number" } ], "title": "Clustering Amount" }, "clustering_enabled": { "title": "Clustering Enabled", "type": "boolean" }, "clustering_threshold": { "title": "Clustering Threshold", "type": "number" }, "disable_key_drive_analysis": { "additionalProperties": { "type": "boolean" }, "title": "Disable Key Drive Analysis", "type": "object" }, "forecast": { "$ref": "#/components/schemas/ForecastConfig" }, "forecast_confidence": { "title": "Forecast Confidence", "type": "number" }, "forecast_enabled": { "title": "Forecast Enabled", "type": "boolean" }, "forecast_period": { "anyOf": [ { "type": "integer" }, { "type": "number" } ], "title": "Forecast Period" }, "forecast_seasonal": { "title": "Forecast Seasonal", "type": "boolean" }, "whatIf": { "$ref": "#/components/schemas/WhatIfScenarioConfig" } }, "title": "VisualizationConfig", "type": "object" }, "VisualizationExcludedResponse": { "properties": { "reason": { "title": "Reason", "type": "string" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "visualizationId": { "title": "Visualizationid", "type": "string" } }, "required": [ "visualizationId", "reason" ], "title": "VisualizationExcludedResponse", "type": "object" }, "VisualizationFilter": { "oneOf": [ { "$ref": "#/components/schemas/VisualizationAttributeFilter" }, { "$ref": "#/components/schemas/VisualizationAbsoluteDateFilter" }, { "$ref": "#/components/schemas/VisualizationRelativeDateFilter" }, { "$ref": "#/components/schemas/VisualizationMetricValueComparisonFilter" }, { "$ref": "#/components/schemas/VisualizationMetricValueRangeFilter" }, { "$ref": "#/components/schemas/VisualizationTopRankingFilter" }, { "$ref": "#/components/schemas/VisualizationBottomRankingFilter" } ] }, "VisualizationIdUpdateRequest": { "description": "PATCH /conversations/{conversationId}/visualizations/{visualizationId} body.", "properties": { "id": { "minLength": 1, "title": "Id", "type": "string" } }, "required": [ "id" ], "title": "VisualizationIdUpdateRequest", "type": "object" }, "VisualizationIncludedResponse": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "visualizationId": { "title": "Visualizationid", "type": "string" } }, "required": [ "visualizationId" ], "title": "VisualizationIncludedResponse", "type": "object" }, "VisualizationMetricValueComparisonFilter": { "additionalProperties": false, "properties": { "condition": { "$ref": "#/components/schemas/MetricValueFilterConditionComparison" }, "nullValuesAsZero": { "title": "Nullvaluesaszero", "type": "boolean" }, "type": { "const": "metric_value_filter", "title": "Type", "type": "string" }, "using": { "title": "Using", "type": "string" }, "value": { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "title": "Value" } }, "required": [ "type", "using", "condition", "value", "nullValuesAsZero" ], "title": "VisualizationMetricValueComparisonFilter", "type": "object" }, "VisualizationMetricValueRangeFilter": { "additionalProperties": false, "properties": { "condition": { "$ref": "#/components/schemas/MetricValueFilterConditionRange" }, "from": { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "title": "From" }, "nullValuesAsZero": { "title": "Nullvaluesaszero", "type": "boolean" }, "to": { "anyOf": [ { "type": "number" }, { "type": "integer" } ], "title": "To" }, "type": { "const": "metric_value_filter", "title": "Type", "type": "string" }, "using": { "title": "Using", "type": "string" } }, "required": [ "type", "using", "condition", "from", "to", "nullValuesAsZero" ], "title": "VisualizationMetricValueRangeFilter", "type": "object" }, "VisualizationObjectExecution": { "properties": { "filters": { "description": "Additional AFM filters merged on top of the visualization object's own filters.", "items": { "$ref": "#/components/schemas/FilterDefinition" }, "type": "array" }, "settings": { "$ref": "#/components/schemas/ExecutionSettings" } }, "type": "object" }, "VisualizationPart": { "additionalProperties": false, "properties": { "type": { "const": "visualization", "default": "visualization", "description": "Type of multipart part.", "title": "Type", "type": "string" }, "visualization": { "anyOf": [ { "$ref": "#/components/schemas/Visualization" }, { "type": "null" } ], "description": "Optional full visualization payload (AAC JSON) when available." } }, "title": "VisualizationPart", "type": "object" }, "VisualizationRelativeDateFilter": { "additionalProperties": false, "properties": { "from": { "title": "From", "type": "integer" }, "granularity": { "$ref": "#/components/schemas/DateFilterGranularity" }, "to": { "title": "To", "type": "integer" }, "type": { "const": "date_filter", "title": "Type", "type": "string" }, "using": { "title": "Using", "type": "string" } }, "required": [ "type", "using", "granularity", "from", "to" ], "title": "VisualizationRelativeDateFilter", "type": "object" }, "VisualizationSwitcherWidgetDescriptor": { "description": "Visualization switcher widget allowing users to toggle between multiple visualizations.", "properties": { "activeVisualizationId": { "description": "ID of the currently active visualization in the switcher.", "type": "string" }, "filters": { "description": "Filters currently applied to the dashboard.", "items": { "$ref": "#/components/schemas/FilterDefinition" }, "type": "array" }, "resultId": { "description": "Signed result ID for the currently active visualization's execution result.", "type": "string" }, "title": { "description": "Widget title as displayed on the dashboard.", "type": "string" }, "visualizationIds": { "description": "IDs of all visualizations available in the switcher.", "items": { "type": "string" }, "type": "array" }, "widgetId": { "description": "Widget object ID.", "type": "string" } }, "required": [ "activeVisualizationId", "title", "visualizationIds", "widgetId" ], "type": "object" }, "VisualizationTopRankingFilter": { "additionalProperties": false, "properties": { "attribute": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Attribute" }, "top": { "title": "Top", "type": "integer" }, "type": { "const": "ranking_filter", "title": "Type", "type": "string" }, "using": { "title": "Using", "type": "string" } }, "required": [ "type", "using", "top" ], "title": "VisualizationTopRankingFilter", "type": "object" }, "Webhook": { "allOf": [ { "properties": { "hasSecretKey": { "description": "Flag indicating if webhook has a hmac secret key.", "maxLength": 10000, "nullable": true, "readOnly": true, "type": "boolean" }, "hasToken": { "description": "Flag indicating if webhook has a token.", "maxLength": 10000, "nullable": true, "readOnly": true, "type": "boolean" }, "secretKey": { "description": "Hmac secret key for the webhook signature.", "example": "secret_key", "maxLength": 10000, "nullable": true, "type": "string", "writeOnly": true }, "token": { "description": "Bearer token for the webhook.", "example": "secret", "maxLength": 10000, "nullable": true, "type": "string", "writeOnly": true }, "type": { "description": "The destination type.", "enum": [ "WEBHOOK" ], "type": "string" }, "url": { "description": "The webhook URL.", "example": "https://webhook.site/something", "maxLength": 255, "pattern": "https?\\://.*", "type": "string" } }, "type": "object" } ], "description": "Webhook destination for notifications. The property url is required on create and update.", "properties": { "hasSecretKey": { "description": "Flag indicating if webhook has a hmac secret key.", "maxLength": 10000, "nullable": true, "readOnly": true, "type": "boolean" }, "hasToken": { "description": "Flag indicating if webhook has a token.", "maxLength": 10000, "nullable": true, "readOnly": true, "type": "boolean" }, "secretKey": { "description": "Hmac secret key for the webhook signature.", "example": "secret_key", "maxLength": 10000, "nullable": true, "type": "string", "writeOnly": true }, "token": { "description": "Bearer token for the webhook.", "example": "secret", "maxLength": 10000, "nullable": true, "type": "string", "writeOnly": true }, "type": { "description": "The destination type.", "enum": [ "WEBHOOK" ], "type": "string" }, "url": { "description": "The webhook URL.", "example": "https://webhook.site/something", "maxLength": 255, "pattern": "https?\\://.*", "type": "string" } }, "required": [ "type" ], "type": "object" }, "WebhookAutomationInfo": { "properties": { "dashboardTitle": { "type": "string" }, "dashboardURL": { "type": "string" }, "id": { "type": "string" }, "isCustomDashboardURL": { "type": "boolean" }, "title": { "type": "string" } }, "required": [ "dashboardURL", "id", "isCustomDashboardURL" ], "type": "object" }, "WebhookMessage": { "properties": { "data": { "$ref": "#/components/schemas/WebhookMessageData" }, "timestamp": { "format": "date-time", "type": "string" }, "type": { "enum": [ "automation-task.completed", "automation-task.limit-exceeded" ], "type": "string" } }, "required": [ "data", "timestamp", "type" ], "type": "object" }, "WebhookMessageData": { "properties": { "alert": { "$ref": "#/components/schemas/AlertDescription" }, "automation": { "$ref": "#/components/schemas/WebhookAutomationInfo" }, "dashboardTabularExports": { "items": { "$ref": "#/components/schemas/ExportResult" }, "type": "array" }, "details": { "additionalProperties": { "type": "string" }, "type": "object" }, "filters": { "items": { "$ref": "#/components/schemas/NotificationFilter" }, "type": "array" }, "imageExports": { "items": { "$ref": "#/components/schemas/ExportResult" }, "type": "array" }, "notificationSource": { "type": "string" }, "rawExports": { "items": { "$ref": "#/components/schemas/ExportResult" }, "type": "array" }, "recipients": { "items": { "$ref": "#/components/schemas/WebhookRecipient" }, "type": "array" }, "remainingActionCount": { "format": "int32", "type": "integer" }, "slidesExports": { "items": { "$ref": "#/components/schemas/ExportResult" }, "type": "array" }, "tabularExports": { "items": { "$ref": "#/components/schemas/ExportResult" }, "type": "array" }, "visualExports": { "items": { "$ref": "#/components/schemas/ExportResult" }, "type": "array" } }, "required": [ "automation" ], "type": "object" }, "WebhookRecipient": { "properties": { "email": { "type": "string" }, "id": { "type": "string" } }, "required": [ "email", "id" ], "type": "object" }, "WhatIfAnalysisPart": { "additionalProperties": false, "properties": { "type": { "const": "whatIf", "default": "whatIf", "description": "Type of multipart part.", "title": "Type", "type": "string" }, "whatIf": { "anyOf": [ { "$ref": "#/components/schemas/WhatIfScenario" }, { "type": "null" } ], "description": "Optional full what-if scenario payload when available." } }, "title": "WhatIfAnalysisPart", "type": "object" }, "WhatIfMeasureAdjustment": { "additionalProperties": false, "properties": { "metricId": { "description": "Adjusted metric identifier.", "title": "Metricid", "type": "string" }, "metricType": { "description": "Adjusted metric type.", "title": "Metrictype", "type": "string" }, "scenarioMaql": { "description": "Scenario MAQL formula.", "title": "Scenariomaql", "type": "string" } }, "required": [ "metricId", "metricType", "scenarioMaql" ], "title": "WhatIfMeasureAdjustment", "type": "object" }, "WhatIfMeasureAdjustmentConfig": { "description": "Measure adjustments for this scenario", "properties": { "metricId": { "description": "ID of the metric or fact to adjust", "type": "string" }, "metricType": { "description": "Type: metric or fact", "type": "string" }, "scenarioMaql": { "description": "Alternative MAQL expression for this scenario", "type": "string" } }, "required": [ "metricId", "metricType", "scenarioMaql" ], "type": "object" }, "WhatIfScenario": { "additionalProperties": false, "properties": { "includeBaseline": { "description": "Whether baseline values are included.", "title": "Includebaseline", "type": "boolean" }, "scenarios": { "description": "Defined what-if variants.", "items": { "$ref": "#/components/schemas/WhatIfScenarioVariant" }, "title": "Scenarios", "type": "array" }, "visualizationRef": { "description": "Base visualization reference used by scenario.", "title": "Visualizationref", "type": "string" } }, "required": [ "visualizationRef", "scenarios", "includeBaseline" ], "title": "WhatIfScenario", "type": "object" }, "WhatIfScenarioConfig": { "description": "What-if scenario configuration.", "properties": { "includeBaseline": { "description": "Whether baseline (unmodified) values are included", "type": "boolean" }, "scenarios": { "description": "Scenarios with alternative measure calculations", "items": { "$ref": "#/components/schemas/WhatIfScenarioItem" }, "type": "array" } }, "required": [ "includeBaseline", "scenarios" ], "type": "object" }, "WhatIfScenarioItem": { "description": "Scenarios with alternative measure calculations", "properties": { "adjustments": { "description": "Measure adjustments for this scenario", "items": { "$ref": "#/components/schemas/WhatIfMeasureAdjustmentConfig" }, "type": "array" }, "label": { "description": "Human-readable scenario label", "type": "string" } }, "required": [ "adjustments", "label" ], "type": "object" }, "WhatIfScenarioVariant": { "additionalProperties": false, "properties": { "adjustments": { "description": "Scenario adjustments.", "items": { "$ref": "#/components/schemas/WhatIfMeasureAdjustment" }, "title": "Adjustments", "type": "array" }, "label": { "description": "Scenario name.", "title": "Label", "type": "string" } }, "required": [ "label", "adjustments" ], "title": "WhatIfScenarioVariant", "type": "object" }, "WidgetDescriptor": { "description": "Descriptor for a widget on the dashboard.", "discriminator": { "mapping": { "insight": "#/components/schemas/InsightWidgetDescriptor", "richText": "#/components/schemas/RichTextWidgetDescriptor", "visualizationSwitcher": "#/components/schemas/VisualizationSwitcherWidgetDescriptor" }, "propertyName": "widgetType" }, "properties": { "filters": { "items": { "oneOf": [ { "$ref": "#/components/schemas/AbstractMeasureValueFilter" }, { "$ref": "#/components/schemas/FilterDefinitionForSimpleMeasure" }, { "$ref": "#/components/schemas/InlineFilterDefinition" } ] }, "type": "array" }, "title": { "type": "string" }, "widgetId": { "type": "string" }, "widgetType": { "type": "string" } }, "required": [ "title", "widgetId", "widgetType" ], "type": "object" }, "WidgetSlidesTemplate": { "description": "Template for widget slides export.\nAvailable variables: {{currentPageNumber}}, {{dashboardDateFilters}}, {{dashboardDescription}}, {{dashboardFilters}}, {{dashboardId}}, {{dashboardName}}, {{dashboardTags}}, {{dashboardUrl}}, {{exportedAt}}, {{exportedBy}}, {{logo}}, {{totalPages}}, {{workspaceId}}, {{workspaceName}}", "nullable": true, "properties": { "appliedOn": { "description": "Export types this template applies to.", "example": [ "PDF", "PPTX" ], "items": { "enum": [ "PDF", "PPTX" ], "type": "string" }, "minItems": 1, "type": "array" }, "contentSlide": { "$ref": "#/components/schemas/ContentSlideTemplate" } }, "required": [ "appliedOn" ], "type": "object" }, "WorkspaceAutomationIdentifier": { "properties": { "id": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "WorkspaceAutomationManagementBulkRequest": { "properties": { "automations": { "items": { "$ref": "#/components/schemas/WorkspaceAutomationIdentifier" }, "type": "array" } }, "required": [ "automations" ], "type": "object" }, "WorkspaceCacheSettings": { "description": "Cache settings for the workspace.", "properties": { "extraCache": { "description": "Extra cache for the workspace, in bytes.", "format": "int64", "type": "integer" } }, "required": [ "extraCache" ], "type": "object" }, "WorkspaceCacheUsage": { "description": "Data about a particular workspace cache usage.", "properties": { "current": { "$ref": "#/components/schemas/WorkspaceCurrentCacheUsage" }, "removalIntervals": { "description": "List of cache removal intervals for workspace.", "items": { "$ref": "#/components/schemas/CacheRemovalInterval" }, "type": "array" }, "settings": { "$ref": "#/components/schemas/WorkspaceCacheSettings" } }, "required": [ "current", "removalIntervals", "settings" ], "type": "object" }, "WorkspaceCurrentCacheUsage": { "description": "Current cache usage of the workspace.", "properties": { "cacheAvailable": { "description": "Cache available for the workspace.", "format": "int64", "type": "integer" }, "cacheUsed": { "description": "Cache used by the workspace.", "format": "int64", "type": "integer" }, "removalPeriodStart": { "description": "Start timestamp of removal period for the workspace.", "format": "date-time", "type": "string" }, "removedSinceStart": { "description": "Bytes removed since start due to insufficient cache for the workspace.", "format": "int64", "type": "integer" } }, "required": [ "cacheAvailable", "cacheUsed", "removalPeriodStart", "removedSinceStart" ], "type": "object" }, "WorkspaceDataSource": { "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace.", "properties": { "id": { "description": "The ID of the used data source.", "example": "snowflake.instance.1", "type": "string" }, "schemaPath": { "description": "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", "items": { "description": "The part of the schema path.", "example": "subPath", "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "WorkspaceIdentifier": { "description": "A workspace identifier.", "example": "{ id: demo, type: workspace }", "properties": { "id": { "description": "Identifier of the workspace.", "example": "alpha.sales", "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" }, "type": { "description": "A type.", "enum": [ "workspace" ], "example": "workspace", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "WorkspacePermissionAssignment": { "description": "Workspace permission assignments", "properties": { "assigneeIdentifier": { "$ref": "#/components/schemas/AssigneeIdentifier" }, "hierarchyPermissions": { "items": { "enum": [ "MANAGE", "ANALYZE", "EXPORT", "EXPORT_TABULAR", "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", "WRITE_KNOWLEDGE_DOCUMENTS", "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "VIEW" ], "type": "string" }, "type": "array" }, "permissions": { "items": { "enum": [ "MANAGE", "ANALYZE", "EXPORT", "EXPORT_TABULAR", "EXPORT_PDF", "CREATE_AUTOMATION", "USE_AI_ASSISTANT", "WRITE_KNOWLEDGE_DOCUMENTS", "READ_KNOWLEDGE_DOCUMENTS", "CREATE_FILTER_VIEW", "VIEW" ], "type": "string" }, "type": "array" } }, "required": [ "assigneeIdentifier" ], "type": "object" }, "WorkspaceUser": { "description": "List of workspace users", "properties": { "email": { "description": "User email address", "example": "user@example.com", "type": "string" }, "id": { "type": "string" }, "name": { "description": "User name", "example": "John Wick", "type": "string" } }, "required": [ "id" ], "type": "object" }, "WorkspaceUserGroup": { "description": "List of workspace groups", "properties": { "id": { "type": "string" }, "name": { "description": "Group name", "example": "admins", "type": "string" } }, "required": [ "id" ], "type": "object" }, "WorkspaceUserGroups": { "properties": { "totalCount": { "description": "Total number of groups", "format": "int32", "type": "integer" }, "userGroups": { "items": { "$ref": "#/components/schemas/WorkspaceUserGroup" }, "type": "array" } }, "required": [ "totalCount", "userGroups" ], "type": "object" }, "WorkspaceUsers": { "properties": { "totalCount": { "description": "The total number of users is based on applied filters.", "format": "int32", "type": "integer" }, "users": { "items": { "$ref": "#/components/schemas/WorkspaceUser" }, "type": "array" } }, "required": [ "totalCount", "users" ], "type": "object" }, "Xliff": { "properties": { "file": { "items": { "$ref": "#/components/schemas/File" }, "type": "array" }, "otherAttributes": { "additionalProperties": { "type": "string" }, "type": "object" }, "space": { "type": "string" }, "srcLang": { "type": "string" }, "trgLang": { "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "_MeasureValueComparisonInner": { "additionalProperties": false, "properties": { "operator": { "$ref": "#/components/schemas/ComparisonMeasureValueOperator" }, "value": { "title": "Value", "type": "number" } }, "required": [ "operator", "value" ], "title": "_MeasureValueComparisonInner", "type": "object" }, "_MeasureValueRangeInner": { "additionalProperties": false, "properties": { "from": { "title": "From", "type": "number" }, "operator": { "$ref": "#/components/schemas/RangeMeasureValueOperator" }, "to": { "title": "To", "type": "number" } }, "required": [ "operator", "from", "to" ], "title": "_MeasureValueRangeInner", "type": "object" }, "app__application__dtos__afm__filter_definition__DateGranularity": { "enum": [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "QUARTER", "YEAR", "MINUTE_OF_HOUR", "HOUR_OF_DAY", "DAY_OF_WEEK", "DAY_OF_MONTH", "DAY_OF_QUARTER", "DAY_OF_YEAR", "WEEK_OF_YEAR", "MONTH_OF_YEAR", "QUARTER_OF_YEAR", "FISCAL_MONTH", "FISCAL_QUARTER", "FISCAL_YEAR" ], "title": "DateGranularity", "type": "string" }, "app__application__dtos__afm__filter_definition__RankingFilter": { "additionalProperties": false, "properties": { "rankingFilter": { "$ref": "#/components/schemas/RankingFilterBody" } }, "required": [ "rankingFilter" ], "title": "RankingFilter", "type": "object" }, "app__domain__conversations__visualization__DateGranularity": { "description": "Date granularity for date filters.", "enum": [ "DAY", "WEEK_US", "MONTH", "QUARTER", "YEAR" ], "title": "DateGranularity", "type": "string" }, "app__domain__conversations__visualization__RankingFilter": { "additionalProperties": false, "properties": { "attribute": { "title": "Attribute", "type": "string" }, "bottom": { "title": "Bottom", "type": "integer" }, "top": { "title": "Top", "type": "integer" }, "type": { "const": "ranking_filter", "title": "Type", "type": "string" }, "using": { "title": "Using", "type": "string" } }, "required": [ "type", "using" ], "title": "RankingFilter", "type": "object" } } }, "info": { "title": "OpenAPI definition", "version": "1.0.0" }, "openapi": "3.0.1", "paths": { "/api/v1/actions/ai/llmEndpoint/test": { "post": { "deprecated": true, "description": "Permanently removed. Use POST /api/v1/actions/ai/llmProvider/test instead. Always returns 410 Gone.", "operationId": "validateLLMEndpoint", "responses": { "410": { "description": "Gone" } }, "summary": "Validate LLM Endpoint (Removed)", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/ai/llmEndpoint/{llmEndpointId}/test": { "post": { "deprecated": true, "description": "Permanently removed. Use POST /api/v1/actions/ai/llmProvider/{llmProviderId}/test instead. Always returns 410 Gone.", "operationId": "validateLLMEndpointById", "parameters": [ { "in": "path", "name": "llmEndpointId", "required": true, "schema": { "type": "string" } } ], "responses": { "410": { "description": "Gone" } }, "summary": "Validate LLM Endpoint By Id (Removed)", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/ai/llmProvider/listModels": { "post": { "description": "Lists models available on an LLM provider with a full definition. For Azure AI Foundry providers, the model family will be set to UNKNOWN because the endpoint does not expose the family.", "operationId": "listLlmProviderModels", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLlmProviderModelsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLlmProviderModelsResponse" } } }, "description": "OK" } }, "summary": "List LLM Provider Models", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/ai/llmProvider/test": { "post": { "description": "Tests LLM provider connectivity with a full definition.", "operationId": "testLlmProvider", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestLlmProviderDefinitionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestLlmProviderResponse" } } }, "description": "OK" } }, "summary": "Test LLM Provider", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/ai/llmProvider/{llmProviderId}/listModels": { "post": { "description": "Lists models available on an existing LLM provider by its ID. For Azure AI Foundry providers, the model family will be set to UNKNOWN because the endpoint does not expose the family.", "operationId": "listLlmProviderModelsById", "parameters": [ { "in": "path", "name": "llmProviderId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListLlmProviderModelsResponse" } } }, "description": "OK" } }, "summary": "List LLM Provider Models By Id", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/ai/llmProvider/{llmProviderId}/test": { "post": { "description": "Tests an existing LLM provider connectivity by its ID.", "operationId": "testLlmProviderById", "parameters": [ { "in": "path", "name": "llmProviderId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestLlmProviderByIdRequest" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestLlmProviderResponse" } } }, "description": "OK" } }, "summary": "Test LLM Provider By Id", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/collectCacheUsage": { "get": { "description": "Get the detailed data about how much cache your organization is currently using, broken down by individual workspaces.", "operationId": "collectCacheUsage", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CacheUsageData" } } }, "description": "OK" } }, "summary": "Collect data about the current cache usage", "tags": [ "Cache usage" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/collectUsage": { "get": { "description": "Provides information about platform usage, like amount of users, workspaces, ...\n\n_NOTE_: The `admin` user is always excluded from this amount.", "operationId": "allPlatformUsage", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/PlatformUsage" }, "type": "array" } } }, "description": "OK" } }, "summary": "Info about the platform usage.", "tags": [ "Usage" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "MANAGE" ] } }, "post": { "description": "Provides information about platform usage, like amount of users, workspaces, ...\n\n_NOTE_: The `admin` user is always excluded from this amount.", "operationId": "particularPlatformUsage", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformUsageRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/PlatformUsage" }, "type": "array" } } }, "description": "OK" } }, "summary": "Info about the platform usage for particular items.", "tags": [ "Usage" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/customGeoCollection/convert": { "post": { "description": "Converts a geo file from the staging area to GeoParquet format. Supported source formats: GeoJSON (.geojson, .json), ESRI Shapefile (.zip). If the source file is already in GeoParquet format, the same location is returned without conversion.", "operationId": "convertGeoFile", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConvertGeoFileRequest" } } }, "required": true }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ConvertGeoFileResponse" } } }, "description": "Conversion was successful." }, "400": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ConvertGeoFileResponse" } } }, "description": "Invalid request or unsupported file format." } }, "summary": "Convert a geo file to GeoParquet format", "tags": [ "Other" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/customGeoCollection/staging/upload": { "post": { "description": "Provides a location for uploading staging files for custom geo collections. Supported file types: GeoParquet (.parquet), GeoJSON (.geojson, .json), ESRI Shapefile (.zip). Maximum file size: 100 MB.", "operationId": "customGeoCollectionStagingUpload", "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "file": { "description": "The geo collection file to upload. Supported formats: GeoParquet (.parquet), GeoJSON (.geojson, .json), ESRI Shapefile (.zip).", "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" } } } }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UploadGeoCollectionFileResponse" } } }, "description": "Upload was successful." } }, "summary": "Upload a geo collection file to the staging area", "tags": [ "Other" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/customGeoCollection/{collectionId}/import": { "post": { "description": "Import a geo collection file from the staging area to be available for use. The file must be in GeoParquet format (use the convert endpoint first for other formats). Validates file size (max 100 MB), organization storage quota (max 1 GB total), and GeoParquet schema (requires id, geometry, and bbox columns).", "operationId": "importCustomGeoCollection", "parameters": [ { "in": "path", "name": "collectionId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportGeoCollectionRequest" } } }, "required": true }, "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ImportGeoCollectionResponse" } } }, "description": "Successful import." } }, "summary": "Import custom geo collection", "tags": [ "Other" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/dataSource/test": { "post": { "description": "Test if it is possible to connect to a database using a connection provided by the data source definition in the request body.", "operationId": "testDataSourceDefinition", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestDefinitionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "An example of a successful connection": { "description": "An example of a successful connection", "value": { "queryDurationMillis": { "createCacheTable": 235, "simpleSelect": 562 }, "successful": true } }, "An example of an unsuccessful connection": { "description": "An example of an unsuccessful connection", "value": { "error": "Connection exception: Failed to initialize pool: FATAL: password authentication failed for user \"user\"", "successful": false } } }, "schema": { "$ref": "#/components/schemas/TestResponse" } } }, "description": "The result of the test of a data source connection." } }, "summary": "Test connection by data source definition", "tags": [ "Test Connection" ], "x-gdc-security-info": { "description": "Minimal organization permission required to use this endpoint.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/dataSources/{dataSourceId}/computeColumnStatistics": { "post": { "description": "(EXPERIMENTAL) Computes the requested statistical parameters of a column in a data source.", "operationId": "columnStatistics", "parameters": [ { "in": "path", "name": "dataSourceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ColumnStatisticsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ColumnStatisticsResponse" } } }, "description": "OK" } }, "summary": "(EXPERIMENTAL) Compute column statistics", "tags": [ "Computation" ] } }, "/api/v1/actions/dataSources/{dataSourceId}/generateLogicalModel": { "post": { "description": "Generate logical data model (LDM) from physical data model (PDM) stored in data source.", "operationId": "generateLogicalModel", "parameters": [ { "in": "path", "name": "dataSourceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateLdmRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeModel" } } }, "description": "LDM generated successfully." } }, "summary": "Generate logical data model (LDM) from physical data model (PDM)", "tags": [ "Generate Logical Data Model" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/dataSources/{dataSourceId}/managePermissions": { "post": { "description": "Manage Permissions for a Data Source", "operationId": "manageDataSourcePermissions", "parameters": [ { "in": "path", "name": "dataSourceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "An array of data source permissions assignments", "items": { "$ref": "#/components/schemas/DataSourcePermissionAssignment" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "summary": "Manage Permissions for a Data Source", "tags": [ "Manage Permissions", "Permissions" ] } }, "/api/v1/actions/dataSources/{dataSourceId}/scan": { "post": { "description": "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.", "operationId": "scanDataSource", "parameters": [ { "description": "Data source id", "example": "myPostgres", "in": "path", "name": "dataSourceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScanRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "An example of a successful scan": { "description": "An example of a successful scan", "value": { "pdm": { "tables": [ { "columns": [ { "dataType": "NUMERIC", "isPrimaryKey": false, "name": "budget" }, { "dataType": "STRING", "isPrimaryKey": false, "name": "category" }, { "dataType": "NUMERIC", "isPrimaryKey": false, "name": "spend" } ], "id": "campaign_channels", "path": [ "demo", "campaign_channels" ], "type": "TABLE" } ] }, "warnings": [] } } }, "schema": { "$ref": "#/components/schemas/ScanResultPdm" } } }, "description": "The result of the scan." } }, "summary": "Scan a database to get a physical data model (PDM)", "tags": [ "Scanning" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "USE" ] } } }, "/api/v1/actions/dataSources/{dataSourceId}/scanSchemata": { "get": { "description": "It scans a database and reads metadata. The result of the request contains a list of schema names of a database.", "operationId": "getDataSourceSchemata", "parameters": [ { "description": "Data source id", "example": "myPostgres", "in": "path", "name": "dataSourceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "An example of a successful scan": { "description": "An example of a successful scan", "value": { "schemaNames": [ "demo", "public" ] } } }, "schema": { "$ref": "#/components/schemas/DataSourceSchemata" } } }, "description": "The result of the scan schemata" } }, "summary": "Get a list of schema names of a database", "tags": [ "Scanning" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/dataSources/{dataSourceId}/scanSql": { "post": { "description": "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", "operationId": "scanSql", "parameters": [ { "description": "Data source id", "example": "myPostgres", "in": "path", "name": "dataSourceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScanSqlRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "An example of a successful scan": { "description": "An example of a successful scan", "value": { "columns": [ { "dataType": "NUMERIC", "name": "budget" }, { "dataType": "STRING", "name": "category" }, { "dataType": "NUMERIC", "name": "spend" } ], "dataPreview": [ [ "1000", "campaign1", "458.8" ], [ "1800", "campaign2", "144" ] ] } } }, "schema": { "$ref": "#/components/schemas/ScanSqlResponse" } } }, "description": "The result of the scan." } }, "summary": "Collect metadata about SQL query", "tags": [ "Scanning" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/dataSources/{dataSourceId}/scanStatistics": { "post": { "description": "(BETA) Reads pre-computed CBO statistics from StarRocks. Supports both internal catalog (native/PIPE tables) and external catalog (Iceberg tables). Statistics include row counts, data sizes, NDV (number of distinct values), null counts, and min/max values.", "operationId": "scanStatistics", "parameters": [ { "in": "path", "name": "dataSourceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableStatisticsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TableStatisticsResponse" } } }, "description": "OK" } }, "summary": "(BETA) Collect physical table and column statistics from a StarRocks data source", "tags": [ "Other" ], "x-gdc-security-info": { "description": "Permission required to scan statistics.", "permissions": [ "USE" ] } } }, "/api/v1/actions/dataSources/{dataSourceId}/test": { "post": { "description": "Test if it is possible to connect to a database using an existing data source definition.", "operationId": "testDataSource", "parameters": [ { "description": "Data source id", "example": "myPostgres", "in": "path", "name": "dataSourceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "An example of a successful connection": { "description": "An example of a successful connection", "value": { "queryDurationMillis": { "createCacheTable": 235, "simpleSelect": 562 }, "successful": true } }, "An example of an unsuccessful connection": { "description": "An example of an unsuccessful connection", "value": { "error": "Connection exception: Failed to initialize pool: FATAL: password authentication failed for user \"user\"", "successful": false } } }, "schema": { "$ref": "#/components/schemas/TestResponse" } } }, "description": "The result of the test of a data source connection." } }, "summary": "Test data source connection by data source id", "tags": [ "Test Connection" ], "x-gdc-security-info": { "description": "Permissions required to test a data source.", "permissions": [ "USE" ] } } }, "/api/v1/actions/dataSources/{dataSourceId}/uploadNotification": { "post": { "description": "Notification sets up all reports to be computed again with new data.", "operationId": "registerUploadNotification", "parameters": [ { "in": "path", "name": "dataSourceId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "An upload notification has been successfully registered." } }, "summary": "Register an upload notification", "tags": [ "Invalidate Cache" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/fileStorage/dataSources/{dataSourceId}/deleteFiles": { "post": { "description": "Delete the files in the given data source.", "operationId": "deleteFiles", "parameters": [ { "in": "path", "name": "dataSourceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteFilesRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful deletion." } }, "summary": "Delete datasource files", "tags": [ "Data source files deletion" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/fileStorage/dataSources/{dataSourceId}/importCsv": { "post": { "description": "Import the CSV files at the given locations in the staging area to the final location.", "operationId": "importCsv", "parameters": [ { "in": "path", "name": "dataSourceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportCsvRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ImportCsvResponse" }, "type": "array" } } }, "description": "Successful import." } }, "summary": "Import CSV", "tags": [ "Data source files import" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/fileStorage/dataSources/{dataSourceId}/listFiles": { "post": { "description": "List all the files in the given data source.", "operationId": "listFiles", "parameters": [ { "in": "path", "name": "dataSourceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/GdStorageFile" }, "type": "array" } } }, "description": "Successful listing." } }, "summary": "List datasource files", "tags": [ "Data source files listing" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/fileStorage/dataSources/{dataSourceId}/readCsvFileManifests": { "post": { "description": "Read the manifests of the CSV files in the given data source.", "operationId": "readCsvFileManifests", "parameters": [ { "in": "path", "name": "dataSourceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadCsvFileManifestsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ReadCsvFileManifestsResponse" }, "type": "array" } } }, "description": "Successful listing." } }, "summary": "Read CSV file manifests", "tags": [ "Data source files manifest read" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/fileStorage/staging/analyzeCsv": { "post": { "description": "Analyzes CSV files at the given locations", "operationId": "analyzeCsv", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyzeCsvRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AnalyzeCsvResponse" }, "type": "array" } } }, "description": "Successful analysis." } }, "summary": "Analyze CSV", "tags": [ "Data source files analysis" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/fileStorage/staging/upload": { "post": { "description": "Provides a location for uploading staging files.", "operationId": "stagingUpload", "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "file": { "description": "The file to upload.", "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadFileResponse" } } }, "description": "Upload was successful." } }, "summary": "Upload a file to the staging area", "tags": [ "Data source staging location" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/invite": { "post": { "description": "Puts a new invitation requirement into the invitation generator queue. This is a GoodData Cloud specific endpoint.", "operationId": "processInvitation", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invitation" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "summary": "Invite User", "tags": [ "User Authorization" ], "x-gdc-security-info": { "description": "Permissions required to add an invitation.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/ipAllowlistPolicies/{id}/addTargets": { "post": { "operationId": "addTargets", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpAllowlistPolicyTargets" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "summary": "Add targets to IP allowlist policy", "tags": [ "Organization - Entity APIs" ] } }, "/api/v1/actions/ipAllowlistPolicies/{id}/removeTargets": { "post": { "operationId": "removeTargets", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpAllowlistPolicyTargets" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "summary": "Remove targets from IP allowlist policy", "tags": [ "Organization - Entity APIs" ] } }, "/api/v1/actions/notificationChannels/test": { "post": { "description": "Tests the notification channel by sending a test notification.", "operationId": "testNotificationChannel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestDestinationRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "An example of a successful connection": { "description": "An example of a successful connection", "value": { "successful": true } }, "An example of an unsuccessful connection": { "description": "An example of an unsuccessful connection", "value": { "error": "Authentication failed", "successful": false } } }, "schema": { "$ref": "#/components/schemas/TestResponse" } } }, "description": "The result of the test of a notification channel connection." } }, "summary": "Test notification channel.", "tags": [ "Notification Channels" ] } }, "/api/v1/actions/notificationChannels/{notificationChannelId}/test": { "post": { "description": "Tests the existing notification channel by sending a test notification.", "operationId": "testExistingNotificationChannel", "parameters": [ { "in": "path", "name": "notificationChannelId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestDestinationRequest" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "An example of a successful connection": { "description": "An example of a successful connection", "value": { "successful": true } }, "An example of an unsuccessful connection": { "description": "An example of an unsuccessful connection", "value": { "error": "Authentication failed", "successful": false } } }, "schema": { "$ref": "#/components/schemas/TestResponse" } } }, "description": "The result of the test of a notification channel connection." } }, "summary": "Test existing notification channel.", "tags": [ "Notification Channels" ] } }, "/api/v1/actions/notifications": { "get": { "description": "Get latest in-platform notifications for the current user.", "operationId": "getNotifications", "parameters": [ { "description": "Workspace ID to filter notifications by.", "in": "query", "name": "workspaceId", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Filter notifications by read status.", "in": "query", "name": "isRead", "required": false, "schema": { "type": "boolean" }, "style": "form" }, { "description": "Zero-based page index (0..N)", "in": "query", "name": "page", "required": false, "schema": { "default": "0", "minimum": 0, "type": "string" }, "style": "form" }, { "description": "The size of the page to be returned.", "in": "query", "name": "size", "required": false, "schema": { "default": "20", "minimum": 1, "type": "string" }, "style": "form" }, { "description": "Additional meta information to include in the response.", "explode": true, "in": "query", "name": "metaInclude", "required": false, "schema": { "items": { "enum": [ "total", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notifications" } } }, "description": "OK" } }, "summary": "Get latest notifications.", "tags": [ "Notification Channels" ] } }, "/api/v1/actions/notifications/markAsRead": { "post": { "description": "Mark all user in-platform notifications as read.", "operationId": "markAsReadNotificationAll", "parameters": [ { "description": "Workspace ID where to mark notifications as read.", "in": "query", "name": "workspaceId", "required": false, "schema": { "type": "string" }, "style": "form" } ], "responses": { "204": { "description": "No Content" } }, "summary": "Mark all notifications as read.", "tags": [ "Notification Channels" ] } }, "/api/v1/actions/notifications/{notificationId}/markAsRead": { "post": { "description": "Mark in-platform notification by its ID as read.", "operationId": "markAsReadNotification", "parameters": [ { "description": "Notification ID to mark as read.", "in": "path", "name": "notificationId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "summary": "Mark notification as read.", "tags": [ "Notification Channels" ] } }, "/api/v1/actions/organization/automations/delete": { "post": { "operationId": "deleteOrganizationAutomations", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "summary": "Delete selected automations across all workspaces", "tags": [ "Automations" ] } }, "/api/v1/actions/organization/automations/pause": { "post": { "operationId": "pauseOrganizationAutomations", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "summary": "Pause selected automations across all workspaces", "tags": [ "Automations" ] } }, "/api/v1/actions/organization/automations/unpause": { "post": { "operationId": "unpauseOrganizationAutomations", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "summary": "Unpause selected automations across all workspaces", "tags": [ "Automations" ] } }, "/api/v1/actions/organization/automations/unsubscribe": { "delete": { "operationId": "unsubscribeAllAutomations", "responses": { "204": { "description": "No Content" } }, "summary": "Unsubscribe from all automations in all workspaces", "tags": [ "Automations" ] }, "post": { "operationId": "unsubscribeOrganizationAutomations", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationAutomationManagementBulkRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "summary": "Unsubscribe from selected automations across all workspaces", "tags": [ "Automations" ] } }, "/api/v1/actions/organization/managePermissions": { "post": { "description": "Manage Permissions for a Organization", "operationId": "manageOrganizationPermissions", "requestBody": { "content": { "application/json": { "schema": { "description": "An array of organization permissions assignments", "items": { "$ref": "#/components/schemas/OrganizationPermissionAssignment" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "summary": "Manage Permissions for a Organization", "tags": [ "Permissions" ] } }, "/api/v1/actions/organization/reloadObservabilityLayout": { "post": { "description": "Re-applies the latest GoodData-managed AI observability layout to the organization. Requires the AI_OBSERVABILITY entitlement and organization MANAGE permission. Idempotent; customer-authored content is left untouched.", "operationId": "reloadObservabilityLayout", "responses": { "204": { "description": "No Content" } }, "summary": "Reload the managed AI observability layout", "tags": [ "AI Observability" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/organization/switchActiveIdentityProvider": { "post": { "description": "Switch the active identity provider for the organization. Requires MANAGE permission on the organization.", "operationId": "switchActiveIdentityProvider", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwitchIdentityProviderRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "summary": "Switch Active Identity Provider", "tags": [ "Identity Providers" ] } }, "/api/v1/actions/resolveEntitlements": { "get": { "description": "Resolves values of available entitlements for the organization.", "operationId": "resolveAllEntitlements", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ApiEntitlement" }, "type": "array" } } }, "description": "OK" } }, "summary": "Values for all public entitlements.", "tags": [ "Entitlement" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "VIEW" ] } }, "post": { "description": "Resolves values for requested entitlements in the organization.", "operationId": "resolveRequestedEntitlements", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitlementsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ApiEntitlement" }, "type": "array" } } }, "description": "OK" } }, "summary": "Values for requested public entitlements.", "tags": [ "Entitlement" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "VIEW" ] } } }, "/api/v1/actions/resolveSettings": { "get": { "description": "Resolves values for all settings without workspace by current user, organization, or default settings.", "operationId": "resolveAllSettingsWithoutWorkspace", "parameters": [ { "description": "If true, user-level settings are excluded from resolution.", "in": "query", "name": "excludeUserSettings", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ResolvedSetting" }, "type": "array" } } }, "description": "Values for selected settings." } }, "summary": "Values for all settings without workspace.", "tags": [ "Reporting - Settings" ] }, "post": { "description": "Resolves values for selected settings without workspace by current user, organization, or default settings.", "operationId": "resolveSettingsWithoutWorkspace", "parameters": [ { "description": "If true, user-level settings are excluded from resolution.", "in": "query", "name": "excludeUserSettings", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolveSettingsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ResolvedSetting" }, "type": "array" } } }, "description": "Values for selected settings." } }, "summary": "Values for selected settings without workspace.", "tags": [ "Reporting - Settings" ] } }, "/api/v1/actions/userManagement/assignPermissions": { "post": { "operationId": "assignPermissions", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionsAssignment" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "tags": [ "User management" ] } }, "/api/v1/actions/userManagement/removeUsersUserGroups": { "post": { "operationId": "removeUsersUserGroups", "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AssigneeIdentifier" }, "type": "array" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "tags": [ "User management" ] } }, "/api/v1/actions/userManagement/revokePermissions": { "post": { "operationId": "revokePermissions", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermissionsAssignment" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "tags": [ "User management" ] } }, "/api/v1/actions/userManagement/userGroups": { "get": { "operationId": "listUserGroups", "parameters": [ { "description": "Zero-based page index (0..N)", "example": "page=0", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "int32", "type": "integer" }, "style": "form" }, { "description": "The size of the page to be returned.", "example": "size=20", "in": "query", "name": "size", "required": false, "schema": { "default": 20, "format": "int32", "type": "integer" }, "style": "form" }, { "description": "Filter by user name. Note that user name is case insensitive.", "example": "name=charles", "in": "query", "name": "name", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Filter by workspaceId.", "example": "workspace=demo", "in": "query", "name": "workspace", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Filter by dataSourceId.", "example": "dataSource=demo-test-ds", "in": "query", "name": "dataSource", "required": false, "schema": { "type": "string" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserManagementUserGroups" } } }, "description": "OK" } }, "tags": [ "User management" ] } }, "/api/v1/actions/userManagement/userGroups/{userGroupId}/addMembers": { "post": { "operationId": "addGroupMembers", "parameters": [ { "in": "path", "name": "userGroupId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserManagementUserGroupMembers" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "tags": [ "User management" ] } }, "/api/v1/actions/userManagement/userGroups/{userGroupId}/members": { "get": { "operationId": "getGroupMembers", "parameters": [ { "in": "path", "name": "userGroupId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserManagementUserGroupMembers" } } }, "description": "OK" } }, "tags": [ "User management" ] } }, "/api/v1/actions/userManagement/userGroups/{userGroupId}/permissions": { "get": { "operationId": "listPermissionsForUserGroup", "parameters": [ { "in": "path", "name": "userGroupId", "required": true, "schema": { "type": "string" } }, { "description": "When true, include permissions inherited from parent user groups (workspaces also cascade down the workspace hierarchy). Each workspace and data source is tagged with how the group gains access. Defaults to false (direct assignments only).", "example": "includeInherited=true", "in": "query", "name": "includeInherited", "required": false, "schema": { "default": false, "type": "boolean" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserManagementPermissionAssignments" } } }, "description": "OK" } }, "tags": [ "User management" ] }, "post": { "operationId": "managePermissionsForUserGroup", "parameters": [ { "in": "path", "name": "userGroupId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserManagementPermissionAssignments" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "tags": [ "User management" ] } }, "/api/v1/actions/userManagement/userGroups/{userGroupId}/removeMembers": { "post": { "operationId": "removeGroupMembers", "parameters": [ { "in": "path", "name": "userGroupId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserManagementUserGroupMembers" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "tags": [ "User management" ] } }, "/api/v1/actions/userManagement/users": { "get": { "operationId": "listUsers", "parameters": [ { "description": "Zero-based page index (0..N)", "example": "page=0", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "int32", "type": "integer" }, "style": "form" }, { "description": "The size of the page to be returned.", "example": "size=20", "in": "query", "name": "size", "required": false, "schema": { "default": 20, "format": "int32", "type": "integer" }, "style": "form" }, { "description": "Filter by user name. Note that user name is case insensitive.", "example": "name=charles", "in": "query", "name": "name", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Filter by workspaceId.", "example": "workspace=demo", "in": "query", "name": "workspace", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Filter by userGroupId.", "example": "group=admin", "in": "query", "name": "group", "required": false, "schema": { "type": "string" }, "style": "form" }, { "description": "Filter by dataSourceId.", "example": "dataSource=demo-test-ds", "in": "query", "name": "dataSource", "required": false, "schema": { "type": "string" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserManagementUsers" } } }, "description": "OK" } }, "tags": [ "User management" ] } }, "/api/v1/actions/userManagement/users/{userId}/permissions": { "get": { "operationId": "listPermissionsForUser", "parameters": [ { "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } }, { "description": "When true, include permissions inherited from user groups (workspaces also cascade down the workspace hierarchy). Each workspace and data source is tagged with how the user gains access. Defaults to false (direct assignments only).", "example": "includeInherited=true", "in": "query", "name": "includeInherited", "required": false, "schema": { "default": false, "type": "boolean" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserManagementPermissionAssignments" } } }, "description": "OK" } }, "tags": [ "User management" ] }, "post": { "operationId": "managePermissionsForUser", "parameters": [ { "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserManagementPermissionAssignments" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "tags": [ "User management" ] } }, "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/createdBy": { "get": { "description": "Returns a list of Users who created any object for this workspace", "operationId": "createdBy", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsCatalogCreatedBy" } } }, "description": "OK" } }, "summary": "Get Analytics Catalog CreatedBy Users", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateDescription": { "post": { "description": "Generates a description for the specified analytics object. Returns description and a note with details if generation was not performed.", "operationId": "generateDescription", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateDescriptionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateDescriptionResponse" } } }, "description": "OK" } }, "summary": "Generate Description for Analytics Object", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/generateTitle": { "post": { "description": "Generates a title for the specified analytics object. Returns title and a note with details if generation was not performed.", "operationId": "generateTitle", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateTitleRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateTitleResponse" } } }, "description": "OK" } }, "summary": "Generate Title for Analytics Object", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/tags": { "get": { "description": "Returns a list of tags for this workspace", "operationId": "tags", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyticsCatalogTags" } } }, "description": "OK" } }, "summary": "Get Analytics Catalog Tags", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/ai/analyticsCatalog/trendingObjects": { "get": { "description": "Returns a list of trending objects for this workspace", "operationId": "trendingObjects", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrendingObjectsResult" } } }, "description": "OK" } }, "summary": "Get Trending Analytics Catalog Objects", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/ai/chat": { "post": { "description": "(BETA) Combines multiple use cases such as search, create visualizations, ...", "operationId": "aiChat", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatResult" } } }, "description": "OK" } }, "summary": "(BETA) Chat with AI", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/ai/chatHistory": { "post": { "description": "(BETA) Post thread ID (and optionally interaction ID) to get full/partial chat history.", "operationId": "aiChatHistory", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatHistoryRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatHistoryResult" } } }, "description": "OK" } }, "summary": "(BETA) Get Chat History", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/ai/chatStream": { "post": { "description": "(BETA) Combines multiple use cases such as search, create visualizations, ...", "operationId": "aiChatStream", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatRequest" } } }, "required": true }, "responses": { "200": { "content": { "text/event-stream": { "schema": { "items": { "$ref": "#/components/schemas/ServerSentEventChatResult" }, "type": "array" } } }, "description": "OK" } }, "summary": "(BETA) Chat with AI", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/ai/chatUsage": { "get": { "description": "Returns usage statistics of chat for a user in a workspace.", "operationId": "aiChatUsage", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatUsageResponse" } } }, "description": "OK" } }, "summary": "Get Chat Usage", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/ai/issues": { "get": { "description": "Returns metadata quality issues detected by the platform linter.", "operationId": "getQualityIssues", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetQualityIssuesResponse" } } }, "description": "OK" } }, "summary": "Get Quality Issues", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/ai/issues/status/{processId}": { "get": { "description": "Returns the status of a quality issues calculation process identified by process ID.", "operationId": "getQualityIssuesCalculationStatus", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { "in": "path", "name": "processId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QualityIssuesCalculationStatusResponse" } } }, "description": "OK" } }, "summary": "Get Quality Issues Calculation Status", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/ai/issues/triggerCheck": { "post": { "description": "Triggers asynchronous calculation of metadata quality issues and returns a process ID for status tracking.", "operationId": "triggerQualityIssuesCalculation", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriggerQualityIssuesCalculationResponse" } } }, "description": "OK" } }, "summary": "Trigger Quality Issues Calculation", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/ai/memory/createdBy": { "get": { "description": "Returns a list of Users who created any memory item for this workspace", "operationId": "memoryCreatedByUsers", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemoryItemCreatedByUsers" } } }, "description": "OK" } }, "summary": "Get AI Memory CreatedBy Users", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmEndpoints": { "get": { "deprecated": true, "description": "Permanently removed. Use GET /api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmProviders instead. Always returns 410 Gone.", "operationId": "resolveLlmEndpoints", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], "responses": { "410": { "description": "Gone" } }, "summary": "Get Active LLM Endpoints for this workspace (Removed)", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/ai/resolveLlmProviders": { "get": { "description": "Resolves the active LLM provider configuration for the given workspace.", "operationId": "resolveLlmProviders", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolvedLlms" } } }, "description": "OK" } }, "summary": "Get Active LLM configuration for this workspace", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/ai/search": { "post": { "description": "(BETA) Uses similarity (e.g. cosine distance) search to find top X most similar metadata objects.", "operationId": "aiSearch", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResult" } } }, "description": "OK" } }, "summary": "(BETA) Semantic Search in Metadata", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/availableAssignees": { "get": { "operationId": "availableAssignees", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "dashboardId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailableAssignees" } } }, "description": "OK" } }, "summary": "Get Available Assignees", "tags": [ "Permissions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/export/tabular": { "post": { "description": "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.", "operationId": "createDashboardExportRequest", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "dashboardId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardTabularExportRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportResponse" } } }, "description": "Tabular export request created successfully." } }, "summary": "(EXPERIMENTAL) Create dashboard tabular export request", "tags": [ "Tabular export" ], "x-gdc-security-info": { "description": "Permissions required to execute tabular export.", "permissions": [ "EXPORT_TABULAR" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/managePermissions": { "post": { "operationId": "manageDashboardPermissions", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "dashboardId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "An array of dashboard permissions assignments", "items": { "oneOf": [ { "$ref": "#/components/schemas/PermissionsForAssignee" }, { "$ref": "#/components/schemas/PermissionsForAssigneeRule" } ] }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "summary": "Manage Permissions for a Dashboard", "tags": [ "Permissions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/analyticalDashboards/{dashboardId}/permissions": { "get": { "operationId": "dashboardPermissions", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "dashboardId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardPermissions" } } }, "description": "OK" } }, "summary": "Get Dashboard Permissions", "tags": [ "Permissions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/managePermissions": { "post": { "operationId": "manageAttributePermissions", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "attributeId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "An array of attribute-permission assignments.", "items": { "oneOf": [ { "$ref": "#/components/schemas/LdmObjectPermissionsForAssignee" }, { "$ref": "#/components/schemas/LdmObjectPermissionsForAssigneeRule" } ] }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "summary": "Manage Permissions for an Attribute", "tags": [ "Permissions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/attributes/{attributeId}/permissions": { "get": { "operationId": "attributePermissions", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "attributeId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LdmObjectPermissions" } } }, "description": "OK" } }, "summary": "Get Attribute Permissions", "tags": [ "Permissions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/automations/delete": { "post": { "operationId": "deleteWorkspaceAutomations", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "summary": "Delete selected automations in the workspace", "tags": [ "Automations" ] } }, "/api/v1/actions/workspaces/{workspaceId}/automations/pause": { "post": { "operationId": "pauseWorkspaceAutomations", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "summary": "Pause selected automations in the workspace", "tags": [ "Automations" ] } }, "/api/v1/actions/workspaces/{workspaceId}/automations/trigger": { "post": { "description": "Trigger the automation in the request.", "operationId": "triggerAutomation", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TriggerAutomationRequest" } } }, "required": true }, "responses": { "204": { "description": "The automation is successfully triggered." } }, "summary": "Trigger automation.", "tags": [ "Automations" ] } }, "/api/v1/actions/workspaces/{workspaceId}/automations/unpause": { "post": { "operationId": "unpauseWorkspaceAutomations", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "summary": "Unpause selected automations in the workspace", "tags": [ "Automations" ] } }, "/api/v1/actions/workspaces/{workspaceId}/automations/unsubscribe": { "delete": { "operationId": "unsubscribeWorkspaceAutomations", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "summary": "Unsubscribe from all automations in the workspace", "tags": [ "Automations" ] }, "post": { "operationId": "unsubscribeSelectedWorkspaceAutomations", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceAutomationManagementBulkRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "summary": "Unsubscribe from selected automations in the workspace", "tags": [ "Automations" ] } }, "/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/trigger": { "post": { "description": "Trigger the existing automation to execute immediately.", "operationId": "triggerExistingAutomation", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "automationId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "The automation is successfully triggered." } }, "summary": "Trigger existing automation.", "tags": [ "Automations" ] } }, "/api/v1/actions/workspaces/{workspaceId}/automations/{automationId}/unsubscribe": { "delete": { "operationId": "unsubscribeAutomation", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "automationId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "summary": "Unsubscribe from an automation", "tags": [ "Automations" ] } }, "/api/v1/actions/workspaces/{workspaceId}/checkEntityOverrides": { "post": { "description": "Finds entities with given ID in hierarchy (e.g. to check possible future conflicts).", "operationId": "checkEntityOverrides", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "An array of object identifications", "items": { "$ref": "#/components/schemas/HierarchyObjectIdentification" }, "type": "array" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/IdentifierDuplications" }, "type": "array" } } }, "description": "Searching for entities finished successfully." } }, "summary": "Finds entities with given ID in hierarchy.", "tags": [ "Hierarchy" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "ANALYZE" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/dependentEntitiesGraph": { "get": { "description": "Computes the dependent entities graph", "operationId": "getDependentEntitiesGraph", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DependentEntitiesResponse" } } }, "description": "Computes the dependent entities graph" } }, "summary": "Computes the dependent entities graph", "tags": [ "Dependency Graph" ], "x-gdc-security-info": { "description": "Permissions required to read the graph.", "permissions": [ "VIEW" ] } }, "post": { "description": "Computes the dependent entities graph from given entry points", "operationId": "getDependentEntitiesGraphFromEntryPoints", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DependentEntitiesRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DependentEntitiesResponse" } } }, "description": "Computes the dependent entities graph from given entry points" } }, "summary": "Computes the dependent entities graph from given entry points", "tags": [ "Dependency Graph" ], "x-gdc-security-info": { "description": "Permissions required to read the graph.", "permissions": [ "VIEW" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/execution/afm/cancel": { "post": { "description": "Each cancel token corresponds to one unique execution request for the same result id. If all cancel tokens for the same result id are applied, the execution for this result id is cancelled.", "operationId": "cancelExecutions", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AfmCancelTokens" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AfmCancelTokens" } } }, "description": "Status of the cancellation operation." } }, "summary": "Applies all the given cancel tokens.", "tags": [ "Computation" ], "x-gdc-security-info": { "description": "Permissions required to view a report or label elements.", "permissions": [ "VIEW" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidDescendants": { "post": { "description": "(BETA) Returns map of lists of attributes that can be used as descendants of the given attributes.", "operationId": "computeValidDescendants", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AfmValidDescendantsQuery" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AfmValidDescendantsResponse" } } }, "description": "Map of lists of attributes valid as descendants of the given attributes." } }, "summary": "(BETA) Valid descendants", "tags": [ "Computation" ], "x-gdc-security-info": { "description": "Permissions required to analyze data.", "permissions": [ "ANALYZE" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/execution/afm/computeValidObjects": { "post": { "description": "Returns list containing attributes, facts, or metrics, which can be added to given AFM while still keeping it computable.", "operationId": "computeValidObjects", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AfmValidObjectsQuery" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AfmValidObjectsResponse" } } }, "description": "List of attributes, facts and metrics valid with respect to given AFM." } }, "summary": "Valid objects", "tags": [ "Computation" ], "x-gdc-security-info": { "description": "Permissions required to view data.", "permissions": [ "VIEW" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute": { "post": { "description": "AFM is a combination of attributes, measures and filters that describe a query you want to execute.", "operationId": "computeReport", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { "description": "Ignore all caches during execution of current request.", "in": "header", "name": "skip-cache", "required": false, "schema": { "default": false, "type": "boolean" } }, { "deprecated": true, "example": "2020-06-03T10:15:30+01:00", "in": "header", "name": "timestamp", "required": false, "schema": { "description": "Timestamp for the execution. Deprecated, use `settings.timestamp` in the request body.", "format": "timestamp", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AfmExecution" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AfmExecutionResponse" } } }, "description": "AFM Execution response with links to the result and server-enhanced dimensions from the original request.", "headers": { "X-GDC-CANCEL-TOKEN": { "description": "A token that can be used to cancel this execution", "schema": { "type": "string" }, "style": "simple" } } } }, "summary": "Executes analytical request and returns link to the result", "tags": [ "Computation" ], "x-gdc-security-info": { "description": "Permissions required to view a report or label elements.", "permissions": [ "VIEW" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}": { "get": { "description": "Gets a single execution result.", "operationId": "retrieveResult", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { "description": "Result ID", "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", "name": "resultId", "required": true, "schema": { "type": "string" } }, { "description": "Request page with these offsets. Format is offset=1,2,3,... - one offset for each dimensions in ResultSpec from originating AFM.", "example": "offset=1,10", "explode": false, "in": "query", "name": "offset", "required": false, "schema": { "default": [], "items": { "format": "int32", "type": "integer" }, "type": "array" }, "style": "form" }, { "description": "Return only this number of items. Format is limit=1,2,3,... - one limit for each dimensions in ResultSpec from originating AFM.", "example": "limit=1,10", "explode": false, "in": "query", "name": "limit", "required": false, "schema": { "default": [], "items": { "format": "int32", "type": "integer" }, "type": "array" }, "style": "form" }, { "description": "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.", "example": "excludedTotalDimensions=dim_0,dim_1", "explode": false, "in": "query", "name": "excludedTotalDimensions", "required": false, "schema": { "default": [], "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "in": "header", "name": "X-GDC-CANCEL-TOKEN", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutionResult" } } }, "description": "Execution result was found and returned." } }, "summary": "Get a single execution result", "tags": [ "Computation" ], "x-gdc-security-info": { "description": "Permissions required to view a report or label elements.", "permissions": [ "VIEW" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/binary": { "get": { "description": "(BETA) Gets a single execution result as an Apache Arrow IPC File or Stream format.", "operationId": "retrieveResultBinary", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { "description": "Result ID", "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", "name": "resultId", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "X-GDC-CANCEL-TOKEN", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/vnd.apache.arrow.file": { "schema": { "format": "binary", "type": "string" } }, "application/vnd.apache.arrow.stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "Execution result was found and returned." } }, "summary": "(BETA) Get a single execution result in Apache Arrow File or Stream format", "tags": [ "Computation" ], "x-gdc-security-info": { "description": "Permissions required to view a report or label elements.", "permissions": [ "VIEW" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata": { "get": { "description": "The resource provides execution result's metadata as AFM and resultSpec used in execution request and an executionResponse", "operationId": "retrieveExecutionMetadata", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { "description": "Result ID", "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", "name": "resultId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResultCacheMetadata" } } }, "description": "Execution result's metadata was found and returned." } }, "summary": "Get a single execution result's metadata.", "tags": [ "Computation" ], "x-gdc-security-info": { "description": "Permissions required to analyze data.", "permissions": [ "ANALYZE" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/execution/afm/explain": { "post": { "description": "The resource provides static structures needed for investigation of a problem with given AFM.", "operationId": "explainAFM", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { "description": "Requested explain type. If not specified all types are bundled in a ZIP archive.\n\n`MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info\n\n`GRPC_MODEL` - Datasets used in execution\n\n`GRPC_MODEL_SVG` - Generated SVG image of the datasets\n\n`COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query\n\n`WDF` - Workspace data filters in execution workspace context\n\n`QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL\n\n`QT_SVG` - Generated SVG image of the Query Tree\n\n`OPT_QT` - Optimized Query Tree\n\n`OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree\n\n`SQL` - Final SQL to be executed\n\n`COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets\n\n`SETTINGS` - Settings used to execute explain request\n\n`GIT` - Git properties of current build", "in": "query", "name": "explainType", "required": false, "schema": { "enum": [ "MAQL", "GRPC_MODEL", "GRPC_MODEL_SVG", "WDF", "QT", "QT_SVG", "OPT_QT", "OPT_QT_SVG", "SQL", "SETTINGS", "COMPRESSED_SQL", "COMPRESSED_GRPC_MODEL_SVG", "GIT" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AfmExecution" } } }, "required": true }, "responses": { "200": { "content": { "application/json": {}, "application/sql": {}, "application/zip": { "schema": { "description": "ZIP with MAQL, GRPC_MODEL, GRPC_MODEL_SVG, WDF, QT, QT_SVG, OPT_QT, OPT_QT_SVG and SQL files", "format": "binary", "type": "string" } }, "image/svg+xml": {} }, "description": "Requested resource" } }, "summary": "AFM explain resource.", "tags": [ "Computation" ], "x-gdc-security-info": { "description": "Permissions required to analyze data.", "permissions": [ "ANALYZE" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/execution/collectLabelElements": { "post": { "description": "Returns paged list of elements (values) of given label satisfying given filtering criteria.", "operationId": "computeLabelElementsPost", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { "description": "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.", "in": "query", "name": "offset", "required": false, "schema": { "default": 0, "format": "int32", "maximum": 10000, "minimum": 0, "type": "integer" } }, { "description": "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.", "in": "query", "name": "limit", "required": false, "schema": { "default": 1000, "format": "int32", "maximum": 10000, "minimum": 1, "type": "integer" } }, { "description": "Ignore all caches during execution of current request.", "in": "header", "name": "skip-cache", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ElementsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ElementsResponse" } } }, "description": "List of label values." } }, "summary": "Listing of label values. The resulting data are limited by the static platform limit to the maximum of 10000 rows.", "tags": [ "Computation" ], "x-gdc-security-info": { "description": "Permissions required to view a report or label elements.", "permissions": [ "VIEW" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis": { "post": { "description": "Computes change analysis for the provided execution definition.", "operationId": "changeAnalysis", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeAnalysisRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeAnalysisResponse" } } }, "description": "OK" } }, "summary": "Compute change analysis", "tags": [ "Computation" ] } }, "/api/v1/actions/workspaces/{workspaceId}/execution/computeChangeAnalysis/result/{resultId}": { "get": { "description": "Gets change analysis result.", "operationId": "changeAnalysisResult", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { "description": "Result ID", "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", "name": "resultId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeAnalysisResult" } } }, "description": "OK" } }, "summary": "Get change analysis result", "tags": [ "Computation" ] } }, "/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers": { "post": { "description": "(EXPERIMENTAL) Computes key driver analysis for the provided execution definition.", "operationId": "keyDriverAnalysis", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { "description": "Ignore all caches during execution of current request.", "in": "header", "name": "skip-cache", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyDriversRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyDriversResponse" } } }, "description": "OK" } }, "summary": "(EXPERIMENTAL) Compute key driver analysis", "tags": [ "Computation" ] } }, "/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers/result/{resultId}": { "get": { "description": "(EXPERIMENTAL) Gets key driver analysis.", "operationId": "keyDriverAnalysisResult", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { "description": "Result ID", "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", "name": "resultId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "offset", "required": false, "schema": { "format": "int32", "type": "integer" } }, { "in": "query", "name": "limit", "required": false, "schema": { "format": "int32", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeyDriversResult" } } }, "description": "OK" } }, "summary": "(EXPERIMENTAL) Get key driver analysis result", "tags": [ "Computation" ] } }, "/api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers": { "post": { "description": "(BETA) Computes outlier detection for the provided execution definition.", "operationId": "outlierDetection", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { "description": "Ignore all caches during execution of current request.", "in": "header", "name": "skip-cache", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutlierDetectionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutlierDetectionResponse" } } }, "description": "OK" } }, "summary": "(BETA) Outlier Detection", "tags": [ "Computation" ] } }, "/api/v1/actions/workspaces/{workspaceId}/execution/detectOutliers/result/{resultId}": { "get": { "description": "(BETA) Gets outlier detection result.", "operationId": "outlierDetectionResult", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { "description": "Result ID", "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", "name": "resultId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "offset", "required": false, "schema": { "format": "int32", "type": "integer" } }, { "in": "query", "name": "limit", "required": false, "schema": { "format": "int32", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutlierDetectionResult" } } }, "description": "OK" } }, "summary": "(BETA) Outlier Detection Result", "tags": [ "Computation" ] } }, "/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/result/{resultId}": { "get": { "deprecated": true, "description": "(EXPERIMENTAL) Gets anomalies.", "operationId": "anomalyDetectionResult", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { "description": "Result ID", "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", "name": "resultId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "offset", "required": false, "schema": { "format": "int32", "type": "integer" } }, { "in": "query", "name": "limit", "required": false, "schema": { "format": "int32", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnomalyDetectionResult" } } }, "description": "OK" } }, "summary": "(EXPERIMENTAL) Smart functions - Anomaly Detection Result", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/{resultId}": { "post": { "deprecated": true, "description": "(EXPERIMENTAL) Computes anomaly detection.", "operationId": "anomalyDetection", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { "description": "Input result ID to be used in the computation", "example": "9bd52018570364264fcf62d373da6bed313120e8", "in": "path", "name": "resultId", "required": true, "schema": { "type": "string" } }, { "description": "Ignore all caches during execution of current request.", "in": "header", "name": "skip-cache", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnomalyDetectionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmartFunctionResponse" } } }, "description": "OK" } }, "summary": "(EXPERIMENTAL) Smart functions - Anomaly Detection", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/result/{resultId}": { "get": { "description": "(EXPERIMENTAL) Gets clustering result.", "operationId": "clusteringResult", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { "description": "Result ID", "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", "name": "resultId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "offset", "required": false, "schema": { "format": "int32", "type": "integer" } }, { "in": "query", "name": "limit", "required": false, "schema": { "format": "int32", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClusteringResult" } } }, "description": "OK" } }, "summary": "(EXPERIMENTAL) Smart functions - Clustering Result", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/execution/functions/clustering/{resultId}": { "post": { "description": "(EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters.", "operationId": "clustering", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { "description": "Input result ID to be used in the computation", "example": "9bd52018570364264fcf62d373da6bed313120e8", "in": "path", "name": "resultId", "required": true, "schema": { "type": "string" } }, { "description": "Ignore all caches during execution of current request.", "in": "header", "name": "skip-cache", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClusteringRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmartFunctionResponse" } } }, "description": "OK" } }, "summary": "(EXPERIMENTAL) Smart functions - Clustering", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId}": { "get": { "description": "Gets forecast result.", "operationId": "forecastResult", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { "description": "Result ID", "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781", "in": "path", "name": "resultId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "offset", "required": false, "schema": { "format": "int32", "type": "integer" } }, { "in": "query", "name": "limit", "required": false, "schema": { "format": "int32", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForecastResult" } } }, "description": "OK" } }, "summary": "Smart functions - Forecast Result", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId}": { "post": { "description": "Computes forecasted data points from the provided execution result and parameters.", "operationId": "forecast", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { "description": "Input result ID to be used in the computation", "example": "9bd52018570364264fcf62d373da6bed313120e8", "in": "path", "name": "resultId", "required": true, "schema": { "type": "string" } }, { "description": "Ignore all caches during execution of current request.", "in": "header", "name": "skip-cache", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForecastRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmartFunctionResponse" } } }, "description": "OK" } }, "summary": "Smart functions - Forecast", "tags": [ "Smart Functions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/execution/visualization/{visualizationObjectId}/execute": { "post": { "description": "(BETA) Fetches a stored visualization object by ID, converts it to an AFM execution, and returns a link to the result. Optionally accepts additional AFM filters merged on top of the visualization's own filters.", "operationId": "computeReportForVisualizationObject", "parameters": [ { "description": "Workspace identifier", "in": "path", "name": "workspaceId", "required": true, "schema": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", "type": "string" } }, { "in": "path", "name": "visualizationObjectId", "required": true, "schema": { "type": "string" } }, { "description": "Ignore all caches during execution of current request.", "in": "header", "name": "skip-cache", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisualizationObjectExecution" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AfmExecutionResponse" } } }, "description": "AFM Execution response with links to the result and server-enhanced dimensions.", "headers": { "X-GDC-CANCEL-TOKEN": { "description": "A token that can be used to cancel this execution", "schema": { "type": "string" }, "style": "simple" } } } }, "summary": "(BETA) Executes a visualization object and returns link to the result", "tags": [ "Computation" ], "x-gdc-security-info": { "description": "Requires workspace VIEW permission.", "permissions": [ "VIEW" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/export/image": { "post": { "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. An image 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.", "operationId": "createImageExport", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImageExportRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportResponse" } } }, "description": "Image export request created successfully." } }, "summary": "(EXPERIMENTAL) Create image export request", "tags": [ "Image export" ], "x-gdc-security-info": { "description": "Permissions required to execute image export.", "permissions": [ "EXPORT_PDF" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}": { "get": { "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. 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.", "operationId": "getImageExport", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "exportId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "image/png": { "schema": { "format": "binary", "type": "string" } } }, "description": "Binary export result.", "headers": { "Content-Disposition": { "schema": { "example": "attachment; filename='result.png'", "pattern": "attachment; filename='[^']+'", "type": "string" }, "style": "simple" } } }, "202": { "content": { "image/png": { "schema": { "items": { "properties": { "char": { "type": "string" }, "direct": { "type": "boolean" }, "double": { "format": "double", "type": "number" }, "float": { "format": "float", "type": "number" }, "int": { "format": "int32", "type": "integer" }, "long": { "format": "int64", "type": "integer" }, "readOnly": { "type": "boolean" }, "short": { "format": "int32", "type": "integer" } }, "type": "object" }, "type": "array" } } }, "description": "Request is accepted, provided exportId exists, but export is not yet ready." } }, "summary": "(EXPERIMENTAL) Retrieve exported files", "tags": [ "Image export" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "EXPORT_PDF" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/export/image/{exportId}/metadata": { "get": { "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/image endpoint. The metadata structure is not verified.", "operationId": "getImageExportMetadata", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "exportId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Json metadata representation" } }, "summary": "(EXPERIMENTAL) Retrieve metadata context", "tags": [ "Image export" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "EXPORT_PDF" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/export/raw": { "post": { "description": "Note: This API is an experimental and is going to change. Please, use it accordingly.An raw 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.", "operationId": "createRawExport", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RawExportRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportResponse" } } }, "description": "Raw export request created successfully." } }, "summary": "(EXPERIMENTAL) Create raw export request", "tags": [ "Raw export" ], "x-gdc-security-info": { "description": "Permissions required to execute raw export.", "permissions": [ "EXPORT_TABULAR" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/export/raw/{exportId}": { "get": { "description": "Note: This API is an experimental and is going to change. Please, use it accordingly.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.", "operationId": "getRawExport", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "exportId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/vnd.apache.arrow.file": { "schema": { "format": "binary", "type": "string" } }, "application/vnd.apache.arrow.stream": { "schema": { "format": "binary", "type": "string" } }, "text/csv": { "schema": { "format": "binary", "type": "string" } } }, "description": "Binary export result.", "headers": { "Content-Disposition": { "schema": { "example": "attachment; filename='result.csv'", "pattern": "attachment; filename='[^']+'", "type": "string" }, "style": "simple" } } }, "202": { "content": { "application/vnd.apache.arrow.file": { "schema": { "format": "binary", "type": "string" } }, "application/vnd.apache.arrow.stream": { "schema": { "format": "binary", "type": "string" } }, "text/csv": { "schema": { "format": "binary", "type": "string" } } }, "description": "Request is accepted, provided exportId exists, but export is not yet ready." } }, "summary": "(EXPERIMENTAL) Retrieve exported files", "tags": [ "Raw export" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "EXPORT_TABULAR" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/export/slides": { "post": { "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. A slides 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.", "operationId": "createSlidesExport", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "X-Gdc-Debug", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SlidesExportRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportResponse" } } }, "description": "Slides export request created successfully." } }, "summary": "(EXPERIMENTAL) Create slides export request", "tags": [ "Slides export" ], "x-gdc-security-info": { "description": "Permissions required to execute slides export.", "permissions": [ "EXPORT_PDF" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}": { "get": { "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. 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.", "operationId": "getSlidesExport", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "exportId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/pdf": { "schema": { "format": "binary", "type": "string" } }, "application/vnd.openxmlformats-officedocument.presentationml.presentation": { "schema": { "format": "binary", "type": "string" } }, "application/zip": { "schema": { "format": "binary", "type": "string" } } }, "description": "Binary export result.", "headers": { "Content-Disposition": { "schema": { "example": "attachment; filename='result.pdf'", "pattern": "attachment; filename='[^']+'", "type": "string" }, "style": "simple" } } }, "202": { "content": { "application/pdf": { "schema": { "items": { "properties": { "char": { "type": "string" }, "direct": { "type": "boolean" }, "double": { "format": "double", "type": "number" }, "float": { "format": "float", "type": "number" }, "int": { "format": "int32", "type": "integer" }, "long": { "format": "int64", "type": "integer" }, "readOnly": { "type": "boolean" }, "short": { "format": "int32", "type": "integer" } }, "type": "object" }, "type": "array" } }, "application/vnd.openxmlformats-officedocument.presentationml.presentation": { "schema": { "items": { "properties": { "char": { "type": "string" }, "direct": { "type": "boolean" }, "double": { "format": "double", "type": "number" }, "float": { "format": "float", "type": "number" }, "int": { "format": "int32", "type": "integer" }, "long": { "format": "int64", "type": "integer" }, "readOnly": { "type": "boolean" }, "short": { "format": "int32", "type": "integer" } }, "type": "object" }, "type": "array" } } }, "description": "Request is accepted, provided exportId exists, but export is not yet ready." } }, "summary": "(EXPERIMENTAL) Retrieve exported files", "tags": [ "Slides export" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "EXPORT_PDF" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/export/slides/{exportId}/metadata": { "get": { "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/slides endpoint. The metadata structure is not verified.", "operationId": "getSlidesExportMetadata", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "exportId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Json metadata representation" } }, "summary": "(EXPERIMENTAL) Retrieve metadata context", "tags": [ "Slides export" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "EXPORT_PDF" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/export/tabular": { "post": { "description": "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.", "operationId": "createTabularExport", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TabularExportRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportResponse" } } }, "description": "Tabular export request created successfully." } }, "summary": "Create tabular export request", "tags": [ "Tabular export" ], "x-gdc-security-info": { "description": "Permissions required to execute tabular export.", "permissions": [ "EXPORT_TABULAR" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/export/tabular/{exportId}": { "get": { "description": "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.", "operationId": "getTabularExport", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "exportId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/pdf": { "schema": { "format": "binary", "type": "string" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "format": "binary", "type": "string" } }, "application/zip": { "schema": { "format": "binary", "type": "string" } }, "text/csv": { "schema": { "format": "binary", "type": "string" } }, "text/html": { "schema": { "format": "binary", "type": "string" } } }, "description": "Binary export result.", "headers": { "Content-Disposition": { "schema": { "example": "attachment; filename='result.csv'", "pattern": "attachment; filename='[^']+'", "type": "string" }, "style": "simple" } } }, "202": { "content": { "application/pdf": { "schema": { "format": "binary", "type": "string" } }, "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": { "schema": { "format": "binary", "type": "string" } }, "application/zip": { "schema": { "format": "binary", "type": "string" } }, "text/csv": { "schema": { "format": "binary", "type": "string" } }, "text/html": { "schema": { "format": "binary", "type": "string" } } }, "description": "Request is accepted, provided exportId exists, but export is not yet ready." } }, "summary": "Retrieve exported files", "tags": [ "Tabular export" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "EXPORT_TABULAR" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/export/visual": { "post": { "description": "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.", "operationId": "createPdfExport", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "X-Gdc-Debug", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisualExportRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportResponse" } } }, "description": "Visual export request created successfully." } }, "summary": "Create visual - pdf export request", "tags": [ "Visual export" ], "x-gdc-security-info": { "description": "Permissions required to execute pdf export.", "permissions": [ "EXPORT_PDF" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}": { "get": { "description": "Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.", "operationId": "getExportedFile", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "exportId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/pdf": { "schema": { "format": "binary", "type": "string" } }, "application/zip": { "schema": { "format": "binary", "type": "string" } } }, "description": "Binary export result.", "headers": { "Content-Disposition": { "schema": { "example": "attachment; filename='result.pdf'", "pattern": "attachment; filename='[^']+'", "type": "string" }, "style": "simple" } } }, "202": { "content": { "application/pdf": { "schema": { "format": "binary", "type": "string" } }, "application/zip": { "schema": { "format": "binary", "type": "string" } } }, "description": "Request is accepted, provided exportId exists, but export is not yet ready." } }, "summary": "Retrieve exported files", "tags": [ "Visual export" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "EXPORT_PDF" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/export/visual/{exportId}/metadata": { "get": { "description": "This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/visual endpoint. The metadata structure is not verified.", "operationId": "getMetadata", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "exportId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": {} }, "description": "Json metadata representation" } }, "summary": "Retrieve metadata context", "tags": [ "Visual export" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "EXPORT_PDF" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/facts/{factId}/managePermissions": { "post": { "operationId": "manageFactPermissions", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "factId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "An array of fact-permission assignments.", "items": { "oneOf": [ { "$ref": "#/components/schemas/LdmObjectPermissionsForAssignee" }, { "$ref": "#/components/schemas/LdmObjectPermissionsForAssigneeRule" } ] }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "summary": "Manage Permissions for a Fact", "tags": [ "Permissions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/facts/{factId}/permissions": { "get": { "operationId": "factPermissions", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "factId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LdmObjectPermissions" } } }, "description": "OK" } }, "summary": "Get Fact Permissions", "tags": [ "Permissions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/inheritedEntityConflicts": { "get": { "description": "Finds API identifier conflicts in given workspace hierarchy.", "operationId": "inheritedEntityConflicts", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/IdentifierDuplications" }, "type": "array" } } }, "description": "Searching for conflicting identifiers finished successfully" } }, "summary": "Finds identifier conflicts in workspace hierarchy.", "tags": [ "Hierarchy" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/inheritedEntityPrefixes": { "get": { "description": "Get used entity prefixes in hierarchy of parent workspaces", "operationId": "inheritedEntityPrefixes", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "Prefixes used in parent entities" } }, "summary": "Get used entity prefixes in hierarchy", "tags": [ "Hierarchy" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "VIEW" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/managePermissions": { "post": { "operationId": "manageLabelPermissions", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "labelId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "An array of label-permission assignments.", "items": { "oneOf": [ { "$ref": "#/components/schemas/LdmObjectPermissionsForAssignee" }, { "$ref": "#/components/schemas/LdmObjectPermissionsForAssigneeRule" } ] }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "summary": "Manage Permissions for a Label", "tags": [ "Permissions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/labels/{labelId}/permissions": { "get": { "operationId": "labelPermissions", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "labelId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LdmObjectPermissions" } } }, "description": "OK" } }, "summary": "Get Label Permissions", "tags": [ "Permissions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/managePermissions": { "post": { "description": "Manage Permissions for a Workspace and its Workspace Hierarchy", "operationId": "manageWorkspacePermissions", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "description": "An array of workspace permissions assignments", "items": { "$ref": "#/components/schemas/WorkspacePermissionAssignment" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "summary": "Manage Permissions for a Workspace", "tags": [ "Permissions" ] } }, "/api/v1/actions/workspaces/{workspaceId}/overriddenChildEntities": { "get": { "description": "Finds API identifier overrides in given workspace hierarchy.", "operationId": "overriddenChildEntities", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/IdentifierDuplications" }, "type": "array" } } }, "description": "Searching for overridden identifiers finished successfully" } }, "summary": "Finds identifier overrides in workspace hierarchy.", "tags": [ "Hierarchy" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/resolveSettings": { "get": { "description": "Resolves values for all settings in a workspace by current user, workspace, organization, or default settings.", "operationId": "workspaceResolveAllSettings", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "description": "If true, user-level settings are excluded from resolution.", "in": "query", "name": "excludeUserSettings", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ResolvedSetting" }, "type": "array" } } }, "description": "Values for selected settings." } }, "summary": "Values for all settings.", "tags": [ "Workspaces - Settings" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "VIEW" ] } }, "post": { "description": "Resolves value for selected settings in a workspace by current user, workspace, organization, or default settings.", "operationId": "workspaceResolveSettings", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "description": "If true, user-level settings are excluded from resolution.", "in": "query", "name": "excludeUserSettings", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolveSettingsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ResolvedSetting" }, "type": "array" } } }, "description": "Values for selected settings." } }, "summary": "Values for selected settings.", "tags": [ "Workspaces - Settings" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "VIEW" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/setCertification": { "post": { "description": "Set or clear the certification (e.g. CERTIFIED) of a workspace entity. Requires MANAGE permission.", "operationId": "setCertification", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetCertificationRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "summary": "Set Certification", "tags": [ "Other" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/translations": { "get": { "description": "Provides a list of effective translation tags.", "operationId": "getTranslationTags", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "Retrieved list of translation tags." } }, "summary": "Get translation tags.", "tags": [ "Translations" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/translations/clean": { "post": { "description": "Cleans up all translations for a particular locale.", "operationId": "cleanTranslations", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocaleRequest" } } }, "required": true }, "responses": { "204": { "description": "Translations were successfully removed." } }, "summary": "Cleans up translations.", "tags": [ "Translations" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/translations/retrieve": { "post": { "description": "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.", "operationId": "retrieveTranslations", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocaleRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Xliff" } } }, "description": "XLIFF file containing translations for a particular locale." } }, "summary": "Retrieve translations for entities.", "tags": [ "Translations" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/translations/set": { "post": { "description": "Set translation for existing entities in a particular locale.", "operationId": "setTranslations", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Xliff" } } }, "required": true }, "responses": { "204": { "description": "Translations were successfully set." } }, "summary": "Set translations for entities.", "tags": [ "Translations" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/uploadNotification": { "post": { "description": "Notification sets up all reports to be computed again with new data.", "operationId": "registerWorkspaceUploadNotification", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "An upload notification has been successfully registered." } }, "summary": "Register an upload notification", "tags": [ "Invalidate Cache" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "MANAGE" ] } } }, "/api/v1/actions/workspaces/{workspaceId}/userGroups": { "get": { "operationId": "listWorkspaceUserGroups", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "description": "Zero-based page index (0..N)", "example": "page=0", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "int32", "type": "integer" }, "style": "form" }, { "description": "The size of the page to be returned.", "example": "size=20", "in": "query", "name": "size", "required": false, "schema": { "default": 20, "format": "int32", "type": "integer" }, "style": "form" }, { "description": "Filter by user name. Note that user name is case insensitive.", "example": "name=charles", "in": "query", "name": "name", "required": false, "schema": { "type": "string" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUserGroups" } } }, "description": "OK" } }, "tags": [ "User management" ] } }, "/api/v1/actions/workspaces/{workspaceId}/users": { "get": { "operationId": "listWorkspaceUsers", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "description": "Zero-based page index (0..N)", "example": "page=0", "in": "query", "name": "page", "required": false, "schema": { "default": 0, "format": "int32", "type": "integer" }, "style": "form" }, { "description": "The size of the page to be returned.", "example": "size=20", "in": "query", "name": "size", "required": false, "schema": { "default": 20, "format": "int32", "type": "integer" }, "style": "form" }, { "description": "Filter by user name. Note that user name is case insensitive.", "example": "name=charles", "in": "query", "name": "name", "required": false, "schema": { "type": "string" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceUsers" } } }, "description": "OK" } }, "tags": [ "User management" ] } }, "/api/v1/ai/agent/skills": { "get": { "operationId": "listAvailableSkills", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/SkillResponse" }, "title": "Response Listavailableskills", "type": "array" } } }, "description": "Successful Response" } }, "summary": "Get Skills", "tags": [ "Other" ] } }, "/api/v1/ai/organization/observability": { "get": { "description": "Returns AI usage stats for the caller's organization for the current calendar month, alongside the previous month's value. Backed by the ai_usage_counters table populated by the metering pipeline.", "operationId": "getObservabilityOverview", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObservabilityOverviewResponse" } } }, "description": "Successful Response" } }, "summary": "(EXPERIMENTAL) AI observability overview for the caller's organization", "tags": [ "AI Observability" ] } }, "/api/v1/ai/workspaces/{workspace_id}/agents": { "get": { "description": "List agents the calling user can use in this workspace, sorted A-Z.\n\nThis is the personalized \"usable here\" view for the agent switcher --\naccess-filtered to the caller, enabled, non-preview, with per-agent\nlastUsedAt. For agent CRUD/management use the metadata entity endpoint\nGET /api/v1/entities/agents instead.", "operationId": "listAgents", "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "title": "Workspace Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentListResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List agents available to the current user in a workspace", "tags": [ "Agents" ] } }, "/api/v1/ai/workspaces/{workspace_id}/chat/conversations": { "get": { "operationId": "get_conversations_api_v1_ai_workspaces__workspace_id__chat_conversations_get", "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "title": "Workspace Id", "type": "string" } }, { "in": "query", "name": "isPreview", "required": false, "schema": { "default": false, "title": "Ispreview", "type": "boolean" } }, { "in": "query", "name": "page", "required": false, "schema": { "default": 0, "minimum": 0, "title": "Page", "type": "integer" } }, { "in": "query", "name": "size", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "title": "Size", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationListResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Conversations", "tags": [ "Other" ] }, "post": { "operationId": "post_conversations_api_v1_ai_workspaces__workspace_id__chat_conversations_post", "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "title": "Workspace Id", "type": "string" } }, { "in": "query", "name": "isPreview", "required": false, "schema": { "default": false, "title": "Ispreview", "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateConversationRequest" } } } }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Post Conversations", "tags": [ "Other" ] } }, "/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}": { "delete": { "operationId": "delete_conversation_api_v1_ai_workspaces__workspace_id__chat_conversations__conversation_id__delete", "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "title": "Workspace Id", "type": "string" } }, { "in": "path", "name": "conversation_id", "required": true, "schema": { "title": "Conversation Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Delete Conversation", "tags": [ "Other" ] }, "get": { "operationId": "get_conversation_api_v1_ai_workspaces__workspace_id__chat_conversations__conversation_id__get", "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "title": "Workspace Id", "type": "string" } }, { "in": "path", "name": "conversation_id", "required": true, "schema": { "title": "Conversation Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Conversation", "tags": [ "Other" ] }, "patch": { "operationId": "patch_conversation_api_v1_ai_workspaces__workspace_id__chat_conversations__conversation_id__patch", "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "title": "Workspace Id", "type": "string" } }, { "in": "path", "name": "conversation_id", "required": true, "schema": { "title": "Conversation Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationUpdateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationResponse" } } }, "description": "Successful Response" }, "400": { "description": "Bad request payload." }, "404": { "description": "Conversation not found." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Patch Conversation", "tags": [ "Other" ] } }, "/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}/feedback": { "post": { "operationId": "post_feedback_api_v1_ai_workspaces__workspace_id__chat_conversations__conversation_id__feedback_post", "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "title": "Workspace Id", "type": "string" } }, { "in": "path", "name": "conversation_id", "required": true, "schema": { "title": "Conversation Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationFeedbackRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful Response" }, "400": { "description": "Bad request payload." }, "404": { "description": "Conversation or response not found." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Post Feedback", "tags": [ "Other" ] } }, "/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}/generateTitle": { "post": { "operationId": "post_generate_conversation_title_api_v1_ai_workspaces__workspace_id__chat_conversations__conversation_id__generateTitle_post", "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "title": "Workspace Id", "type": "string" } }, { "in": "path", "name": "conversation_id", "required": true, "schema": { "title": "Conversation Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationResponse" } } }, "description": "Successful Response" }, "404": { "description": "Conversation not found." }, "422": { "description": "Title cannot be generated yet or LLM is not configured." } }, "summary": "Post Generate Conversation Title", "tags": [ "Other" ] } }, "/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}/items": { "get": { "operationId": "get_conversation_items_api_v1_ai_workspaces__workspace_id__chat_conversations__conversation_id__items_get", "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "title": "Workspace Id", "type": "string" } }, { "in": "path", "name": "conversation_id", "required": true, "schema": { "title": "Conversation Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationItemListResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Conversation Items", "tags": [ "Other" ] } }, "/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}/messages": { "post": { "operationId": "post_messages_api_v1_ai_workspaces__workspace_id__chat_conversations__conversation_id__messages_post", "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "title": "Workspace Id", "type": "string" } }, { "in": "path", "name": "conversation_id", "required": true, "schema": { "title": "Conversation Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendMessageRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "SSE stream with response_started/item/response_ended events" }, "406": { "description": "Accept header must include text/event-stream" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Post Messages", "tags": [ "Other" ] } }, "/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}/responses": { "get": { "operationId": "get_conversation_responses_api_v1_ai_workspaces__workspace_id__chat_conversations__conversation_id__responses_get", "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "title": "Workspace Id", "type": "string" } }, { "in": "path", "name": "conversation_id", "required": true, "schema": { "title": "Conversation Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationResponseList" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Conversation Responses", "tags": [ "Other" ] } }, "/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}/responses/{response_id}": { "patch": { "operationId": "patch_response_api_v1_ai_workspaces__workspace_id__chat_conversations__conversation_id__responses__response_id__patch", "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "title": "Workspace Id", "type": "string" } }, { "in": "path", "name": "conversation_id", "required": true, "schema": { "title": "Conversation Id", "type": "string" } }, { "in": "path", "name": "response_id", "required": true, "schema": { "title": "Response Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseFeedbackRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful Response" }, "400": { "description": "Bad request payload." }, "404": { "description": "Conversation or response not found." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Patch Response", "tags": [ "Other" ] } }, "/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}/switchAgent": { "post": { "operationId": "switchAgent", "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "title": "Workspace Id", "type": "string" } }, { "in": "path", "name": "conversation_id", "required": true, "schema": { "title": "Conversation Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwitchAgentRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationResponse" } } }, "description": "Successful Response" }, "403": { "description": "User has no access to target agent." }, "404": { "description": "Conversation or target agent not found, or feature flag off." }, "422": { "description": "Cannot switch in a preview conversation." } }, "summary": "Switch the active agent on an existing conversation", "tags": [ "Other" ] } }, "/api/v1/ai/workspaces/{workspace_id}/chat/conversations/{conversation_id}/visualizations/{visualization_id}": { "patch": { "operationId": "patch_visualization_api_v1_ai_workspaces__workspace_id__chat_conversations__conversation_id__visualizations__visualization_id__patch", "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "title": "Workspace Id", "type": "string" } }, { "in": "path", "name": "conversation_id", "required": true, "schema": { "title": "Conversation Id", "type": "string" } }, { "in": "path", "name": "visualization_id", "required": true, "schema": { "title": "Visualization Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisualizationIdUpdateRequest" } } }, "required": true }, "responses": { "204": { "description": "Successful Response" }, "400": { "description": "Bad request payload." }, "404": { "description": "Conversation or visualization not found." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Patch Visualization", "tags": [ "Other" ] } }, "/api/v1/ai/workspaces/{workspace_id}/summary": { "post": { "description": "Note: This API is an experimental and is going to change. Please, use it accordingly. Generates a natural-language summary of a dashboard's visualizations, optionally scoped by an explicit filter context.", "operationId": "summarizeDashboard", "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "title": "Workspace Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SummarizeRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SummarizeResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "(EXPERIMENTAL) Summarize a dashboard", "tags": [ "Other" ] } }, "/api/v1/ailake/database/instances": { "get": { "description": "(BETA) Lists database instances in the organization's AI Lake.", "operationId": "listAiLakeDatabaseInstances", "parameters": [ { "description": "Zero-based page number.", "in": "query", "name": "page", "required": false, "schema": { "default": "0", "description": "Zero-based page number.", "minimum": 0, "type": "string" } }, { "description": "Number of items per page.", "in": "query", "name": "size", "required": false, "schema": { "default": "50", "description": "Number of items per page.", "maximum": 500, "minimum": 1, "type": "string" } }, { "in": "query", "name": "metaInclude", "required": false, "schema": { "items": { "type": "string" }, "type": "array", "uniqueItems": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiListDocumentDatabaseInstance" } } }, "description": "AI Lake database instances successfully retrieved" } }, "summary": "(BETA) List AI Lake Database instances", "tags": [ "AI Lake - Databases" ], "x-gdc-security-info": { "description": "Permissions required to list AI Lake database instances.", "permissions": [ "MANAGE" ] } }, "post": { "description": "(BETA) Creates a new database in the organization's AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress.", "operationId": "provisionAiLakeDatabaseInstance", "parameters": [ { "in": "header", "name": "operation-id", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProvisionDatabaseInstanceRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unit" } } }, "description": "Accepted", "headers": { "operation-id": { "description": "Operation ID to use for polling.", "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", "required": true, "schema": { "type": "string" }, "style": "simple" }, "operation-location": { "description": "Operation location URL that can be used for polling.", "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", "required": true, "schema": { "type": "string" }, "style": "simple" } } } }, "summary": "(BETA) Create a new AILake Database instance", "tags": [ "AI Lake - Databases" ], "x-gdc-security-info": { "description": "Permissions required to provision an AI Lake database instance.", "permissions": [ "MANAGE" ] } } }, "/api/v1/ailake/database/instances/{instanceId}": { "delete": { "description": "(BETA) Deletes an existing database in the organization's AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress.", "operationId": "deprovisionAiLakeDatabaseInstance", "parameters": [ { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "in": "path", "name": "instanceId", "required": true, "schema": { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } }, { "in": "header", "name": "operation-id", "required": false, "schema": { "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unit" } } }, "description": "Accepted", "headers": { "operation-id": { "description": "Operation ID to use for polling.", "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", "required": true, "schema": { "type": "string" }, "style": "simple" }, "operation-location": { "description": "Operation location URL that can be used for polling.", "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", "required": true, "schema": { "type": "string" }, "style": "simple" } } } }, "summary": "(BETA) Delete an existing AILake Database instance", "tags": [ "AI Lake - Databases" ], "x-gdc-security-info": { "description": "Permissions required to provision an AI Lake database instance.", "permissions": [ "MANAGE" ] } }, "get": { "description": "(BETA) Retrieve details of the specified AI Lake database instance in the organization's AI Lake.", "operationId": "getAiLakeDatabaseInstance", "parameters": [ { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "in": "path", "name": "instanceId", "required": true, "schema": { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDocumentDatabaseInstance" } } }, "description": "AI Lake database instance successfully retrieved" } }, "summary": "(BETA) Get the specified AILake Database instance", "tags": [ "AI Lake - Databases" ], "x-gdc-security-info": { "description": "Permissions required to get an AI Lake database instance.", "permissions": [ "MANAGE" ] } } }, "/api/v1/ailake/database/instances/{instanceId}/analyzeStatistics": { "post": { "description": "(BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native/PIPE) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed.", "operationId": "analyzeStatistics", "parameters": [ { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "in": "path", "name": "instanceId", "required": true, "schema": { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } }, { "in": "header", "name": "operation-id", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyzeStatisticsRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unit" } } }, "description": "Statistics analysis scheduled.", "headers": { "operation-id": { "schema": { "format": "uuid", "type": "string" }, "style": "simple" } } } }, "summary": "(BETA) Run ANALYZE TABLE for tables in a database instance", "tags": [ "AI Lake - Pipe Tables" ], "x-gdc-security-info": { "description": "Permissions required to analyze statistics.", "permissions": [ "MANAGE" ] } } }, "/api/v1/ailake/database/instances/{instanceId}/dataSource": { "patch": { "description": "(BETA) Updates the data source ID and name for an existing AI Lake database instance without deleting the underlying database. Use this to recover from a wrong data source ID provisioned on an existing database instance.", "operationId": "updateAiLakeDatabaseDataSource", "parameters": [ { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "in": "path", "name": "instanceId", "required": true, "schema": { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDatabaseDataSourceRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDatabaseDataSourceResponse" } } }, "description": "Data source successfully updated" } }, "summary": "(BETA) Update the data source of an AILake Database instance", "tags": [ "AI Lake - Databases" ], "x-gdc-security-info": { "description": "Permissions required to update the data source of an AI Lake database instance.", "permissions": [ "MANAGE" ] } } }, "/api/v1/ailake/database/instances/{instanceId}/dataSources": { "get": { "description": "(BETA) Returns data source associations for the specified AI Lake database instance.", "operationId": "listAiLakeDatabaseDataSources", "parameters": [ { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "in": "path", "name": "instanceId", "required": true, "schema": { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } }, { "description": "Zero-based page number.", "in": "query", "name": "page", "required": false, "schema": { "default": "0", "description": "Zero-based page number.", "minimum": 0, "type": "string" } }, { "description": "Number of items per page.", "in": "query", "name": "size", "required": false, "schema": { "default": "50", "description": "Number of items per page.", "maximum": 500, "minimum": 1, "type": "string" } }, { "in": "query", "name": "metaInclude", "required": false, "schema": { "items": { "type": "string" }, "type": "array", "uniqueItems": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiListDocumentDataSourceInfo" } } }, "description": "Data sources successfully retrieved" } }, "summary": "(BETA) List data sources of an AILake Database instance", "tags": [ "AI Lake - Databases" ], "x-gdc-security-info": { "description": "Permissions required to list data sources of an AI Lake database instance.", "permissions": [ "MANAGE" ] } }, "post": { "description": "(BETA) Associates an additional metadata-api data source with an existing AI Lake database instance. The new data source uses the same StarRocks connection details as the primary data source.", "operationId": "addAiLakeDatabaseDataSource", "parameters": [ { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "in": "path", "name": "instanceId", "required": true, "schema": { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddDatabaseDataSourceRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddDatabaseDataSourceResponse" } } }, "description": "Data source successfully added" } }, "summary": "(BETA) Add a data source to an AILake Database instance", "tags": [ "AI Lake - Databases" ], "x-gdc-security-info": { "description": "Permissions required to add a data source to an AI Lake database instance.", "permissions": [ "MANAGE" ] } } }, "/api/v1/ailake/database/instances/{instanceId}/dataSources/{dataSourceId}": { "delete": { "description": "(BETA) Removes a data source association from an AI Lake database instance and deletes the corresponding data source from metadata-api. Fails if removing the data source would leave the instance with no data sources.", "operationId": "removeAiLakeDatabaseDataSource", "parameters": [ { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "in": "path", "name": "instanceId", "required": true, "schema": { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } }, { "description": "Identifier of the data source to remove.", "in": "path", "name": "dataSourceId", "required": true, "schema": { "description": "Identifier of the data source to remove.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveDatabaseDataSourceResponse" } } }, "description": "Data source successfully removed" } }, "summary": "(BETA) Remove a data source from an AILake Database instance", "tags": [ "AI Lake - Databases" ], "x-gdc-security-info": { "description": "Permissions required to remove a data source from an AI Lake database instance.", "permissions": [ "MANAGE" ] } } }, "/api/v1/ailake/database/instances/{instanceId}/pipeTables": { "get": { "description": "(BETA) Lists active pipe tables in the given AI Lake database instance.", "operationId": "listAiLakePipeTables", "parameters": [ { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "in": "path", "name": "instanceId", "required": true, "schema": { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } }, { "description": "Zero-based page number.", "in": "query", "name": "page", "required": false, "schema": { "default": "0", "description": "Zero-based page number.", "minimum": 0, "type": "string" } }, { "description": "Number of items per page.", "in": "query", "name": "size", "required": false, "schema": { "default": "50", "description": "Number of items per page.", "maximum": 500, "minimum": 1, "type": "string" } }, { "in": "query", "name": "metaInclude", "required": false, "schema": { "items": { "type": "string" }, "type": "array", "uniqueItems": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiListDocumentPipeTableSummary" } } }, "description": "AI Lake pipe tables successfully retrieved" } }, "summary": "(BETA) List AI Lake pipe tables", "tags": [ "AI Lake - Pipe Tables" ], "x-gdc-security-info": { "description": "Permissions required to list AI Lake pipe tables.", "permissions": [ "MANAGE" ] } }, "post": { "description": "(BETA) Creates a pipe-backed OLAP table in the given AI Lake database instance. Infers schema from parquet files. Returns an operation-id header the client can use to poll for progress.", "operationId": "createAiLakePipeTable", "parameters": [ { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "in": "path", "name": "instanceId", "required": true, "schema": { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } }, { "in": "header", "name": "operation-id", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePipeTableRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unit" } } }, "description": "Accepted", "headers": { "operation-id": { "description": "Operation ID to use for polling.", "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", "required": true, "schema": { "type": "string" }, "style": "simple" }, "operation-location": { "description": "Operation location URL.", "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", "required": true, "schema": { "type": "string" }, "style": "simple" } } } }, "summary": "(BETA) Create a new AI Lake pipe table", "tags": [ "AI Lake - Pipe Tables" ], "x-gdc-security-info": { "description": "Permissions required to create an AI Lake pipe table.", "permissions": [ "MANAGE" ] } } }, "/api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName}": { "delete": { "description": "(BETA) Drops the pipe and OLAP table and removes the record. Returns an operation-id header the client can use to poll for progress.", "operationId": "deleteAiLakePipeTable", "parameters": [ { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "in": "path", "name": "instanceId", "required": true, "schema": { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } }, { "description": "Pipe table name.", "in": "path", "name": "tableName", "required": true, "schema": { "description": "Pipe table name.", "type": "string" } }, { "in": "header", "name": "operation-id", "required": false, "schema": { "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unit" } } }, "description": "Accepted", "headers": { "operation-id": { "description": "Operation ID to use for polling.", "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", "required": true, "schema": { "type": "string" }, "style": "simple" }, "operation-location": { "description": "Operation location URL.", "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", "required": true, "schema": { "type": "string" }, "style": "simple" } } } }, "summary": "(BETA) Delete an AI Lake pipe table", "tags": [ "AI Lake - Pipe Tables" ], "x-gdc-security-info": { "description": "Permissions required to delete an AI Lake pipe table.", "permissions": [ "MANAGE" ] } }, "get": { "description": "(BETA) Returns full details of the specified pipe table.", "operationId": "getAiLakePipeTable", "parameters": [ { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "in": "path", "name": "instanceId", "required": true, "schema": { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } }, { "description": "Pipe table name.", "in": "path", "name": "tableName", "required": true, "schema": { "description": "Pipe table name.", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDocumentPipeTable" } } }, "description": "AI Lake pipe table successfully retrieved" } }, "summary": "(BETA) Get an AI Lake pipe table", "tags": [ "AI Lake - Pipe Tables" ], "x-gdc-security-info": { "description": "Permissions required to get an AI Lake pipe table.", "permissions": [ "MANAGE" ] } } }, "/api/v1/ailake/database/instances/{instanceId}/pipeTables/{tableName}/refresh": { "post": { "description": "(BETA) Deletes all rows for the specified Hive partition and re-loads them from S3. Use after overwriting a partition file in object storage with corrected data. Returns an operation-id header the client can use to poll for progress.", "operationId": "refreshAiLakePipeTablePartition", "parameters": [ { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "in": "path", "name": "instanceId", "required": true, "schema": { "description": "Database instance identifier. Accepts the database name (preferred) or UUID.", "type": "string" } }, { "description": "Pipe table name.", "in": "path", "name": "tableName", "required": true, "schema": { "description": "Pipe table name.", "type": "string" } }, { "in": "header", "name": "operation-id", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshPartitionRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unit" } } }, "description": "Accepted", "headers": { "operation-id": { "description": "Operation ID to use for polling.", "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", "required": true, "schema": { "type": "string" }, "style": "simple" }, "operation-location": { "description": "Operation location URL.", "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", "required": true, "schema": { "type": "string" }, "style": "simple" } } } }, "summary": "(BETA) Refresh a pipe table partition", "tags": [ "AI Lake - Pipe Tables" ], "x-gdc-security-info": { "description": "Permissions required to refresh an AI Lake pipe table partition.", "permissions": [ "MANAGE" ] } } }, "/api/v1/ailake/objectStorages": { "get": { "description": "(BETA) Lists ObjectStorages registered for the organization. Use the returned `name` as `sourceStorageName` in CreatePipeTable, or pass `storageId` to the ProvisionDatabase `storageIds` list. Provider credentials are stripped \u2014 only safe descriptors (id, name, type, bucket, region, endpoint, \u2026) are returned.", "operationId": "listAiLakeObjectStorages", "parameters": [ { "description": "Zero-based page number.", "in": "query", "name": "page", "required": false, "schema": { "default": "0", "description": "Zero-based page number.", "minimum": 0, "type": "string" } }, { "description": "Number of items per page.", "in": "query", "name": "size", "required": false, "schema": { "default": "50", "description": "Number of items per page.", "maximum": 500, "minimum": 1, "type": "string" } }, { "in": "query", "name": "metaInclude", "required": false, "schema": { "items": { "type": "string" }, "type": "array", "uniqueItems": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiListDocumentObjectStorageInfo" } } }, "description": "AI Lake ObjectStorages successfully retrieved" } }, "summary": "(BETA) List registered AI Lake ObjectStorages", "tags": [ "AI Lake - Databases" ], "x-gdc-security-info": { "description": "Permissions required to list registered AI Lake ObjectStorages.", "permissions": [ "MANAGE" ] } } }, "/api/v1/ailake/operations/{operationId}": { "get": { "description": "(BETA) Retrieves details of a Long Running Operation specified by the operation-id.", "operationId": "getAiLakeOperation", "parameters": [ { "description": "Operation ID", "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", "in": "path", "name": "operationId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/FailedOperation" }, { "$ref": "#/components/schemas/PendingOperation" }, { "$ref": "#/components/schemas/SucceededOperation" } ] } } }, "description": "AI Lake Long Running Operation details successfully retrieved" } }, "summary": "(BETA) Get Long Running Operation details", "tags": [ "AI Lake - Services & Operations" ], "x-gdc-security-info": { "description": "Permissions required to get details of a Long Running Operation.", "permissions": [ "MANAGE" ] } } }, "/api/v1/ailake/services": { "get": { "description": "(BETA) Lists services configured for the organization's AI Lake. Returns only non-sensitive fields (id, name).", "operationId": "listAiLakeServices", "parameters": [ { "description": "Zero-based page number.", "in": "query", "name": "page", "required": false, "schema": { "default": "0", "description": "Zero-based page number.", "minimum": 0, "type": "string" } }, { "description": "Number of items per page.", "in": "query", "name": "size", "required": false, "schema": { "default": "50", "description": "Number of items per page.", "maximum": 500, "minimum": 1, "type": "string" } }, { "in": "query", "name": "metaInclude", "required": false, "schema": { "items": { "type": "string" }, "type": "array", "uniqueItems": true } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiListDocumentServiceInfo" } } }, "description": "AI Lake services successfully retrieved" } }, "summary": "(BETA) List AI Lake services", "tags": [ "AI Lake - Services & Operations" ], "x-gdc-security-info": { "description": "Permissions required to list AI Lake services.", "permissions": [ "MANAGE" ] } } }, "/api/v1/ailake/services/{serviceId}/commands/{commandName}/run": { "post": { "description": "(BETA) Runs a specific AI Lake service command.", "operationId": "runAiLakeServiceCommand", "parameters": [ { "in": "path", "name": "serviceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "commandName", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "operation-id", "required": false, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunServiceCommandRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Unit" } } }, "description": "Accepted", "headers": { "operation-id": { "description": "Operation ID to use for polling.", "example": "e9fd5d74-8a1b-46bd-ac60-bd91e9206897", "required": true, "schema": { "type": "string" }, "style": "simple" }, "operation-location": { "description": "Operation location URL that can be used for polling.", "example": "/api/v1/ailake/operations/e9fd5d74-8a1b-46bd-ac60-bd91e9206897", "required": true, "schema": { "type": "string" }, "style": "simple" } } } }, "summary": "(BETA) Run an AI Lake services command", "tags": [ "AI Lake - Services & Operations" ], "x-gdc-security-info": { "description": "Permissions required to run AI Lake service commands.", "permissions": [ "MANAGE" ] } } }, "/api/v1/ailake/services/{serviceId}/status": { "get": { "description": "(BETA) Returns the status of a service in the organization's AI Lake. The status is controller-specific (e.g., available commands, readiness).", "operationId": "getAiLakeServiceStatus", "parameters": [ { "in": "path", "name": "serviceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetServiceStatusResponse" } } }, "description": "AI Lake service status successfully retrieved" } }, "summary": "(BETA) Get AI Lake service status", "tags": [ "AI Lake - Services & Operations" ], "x-gdc-security-info": { "description": "Permissions required to get AI Lake service status.", "permissions": [ "MANAGE" ] } } }, "/api/v1/auth/users": { "get": { "description": "Get all users - dedicated endpoint for user management in the internal OIDC provider. GoodData.CN specific", "operationId": "getUsers", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AuthUser" }, "type": "array", "uniqueItems": true } } }, "description": "OK" } }, "summary": "Get all users", "tags": [ "User Authorization" ] }, "post": { "description": "Create a user - dedicated endpoint for user management in the internal OIDC provider. GoodData.CN specific", "operationId": "createUser", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthUser" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthUser" } } }, "description": "OK" } }, "summary": "Create a user", "tags": [ "User Authorization" ] } }, "/api/v1/auth/users/{userEmail}": { "delete": { "description": "Delete a user - dedicated endpoint for user management in the internal OIDC provider. GoodData.CN specific", "operationId": "deleteUser", "parameters": [ { "in": "path", "name": "userEmail", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } }, "summary": "Delete a user", "tags": [ "User Authorization" ] }, "get": { "description": "Get a user - dedicated endpoint for user management in the internal OIDC provider. GoodData.CN specific", "operationId": "getUser", "parameters": [ { "in": "path", "name": "userEmail", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthUser" } } }, "description": "OK" } }, "summary": "Get a user", "tags": [ "User Authorization" ] }, "put": { "description": "Update a user - dedicated endpoint for user management in the internal OIDC provider. GoodData.CN specific", "operationId": "updateUser", "parameters": [ { "in": "path", "name": "userEmail", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthUser" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthUser" } } }, "description": "OK" } }, "summary": "Update a user", "tags": [ "User Authorization" ] } }, "/api/v1/entities/admin/cookieSecurityConfigurations/{id}": { "get": { "operationId": "getEntity@CookieSecurityConfigurations", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "lastRotation==InstantValue;rotationInterval==DurationValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get CookieSecurityConfiguration", "tags": [ "Cookie Security Configuration" ] }, "patch": { "operationId": "patchEntity@CookieSecurityConfigurations", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "lastRotation==InstantValue;rotationInterval==DurationValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch CookieSecurityConfiguration", "tags": [ "Cookie Security Configuration" ] }, "put": { "operationId": "updateEntity@CookieSecurityConfigurations", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "lastRotation==InstantValue;rotationInterval==DurationValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put CookieSecurityConfiguration", "tags": [ "Cookie Security Configuration" ] } }, "/api/v1/entities/admin/organizations/{id}": { "get": { "operationId": "getEntity@Organizations", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "bootstrapUser,bootstrapUserGroup,identityProvider", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "users", "userGroups", "identityProviders", "bootstrapUser", "bootstrapUserGroup", "identityProvider", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Include Meta objects.", "example": "metaInclude=permissions,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "permissions", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get Organizations", "tags": [ "Organization - Entity APIs" ], "x-gdc-security-info": { "description": "Contains permissions required to manipulate the Organization.", "permissions": [ "MANAGE" ] } }, "patch": { "operationId": "patchEntity@Organizations", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "bootstrapUser,bootstrapUserGroup,identityProvider", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "users", "userGroups", "identityProviders", "bootstrapUser", "bootstrapUserGroup", "identityProvider", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch Organization", "tags": [ "Organization - Entity APIs" ], "x-gdc-security-info": { "description": "Contains permissions required to manipulate the Organization.", "permissions": [ "MANAGE" ] } }, "put": { "operationId": "updateEntity@Organizations", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;hostname==someString;bootstrapUser.id==321;bootstrapUserGroup.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "bootstrapUser,bootstrapUserGroup,identityProvider", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "users", "userGroups", "identityProviders", "bootstrapUser", "bootstrapUserGroup", "identityProvider", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put Organization", "tags": [ "Organization - Entity APIs" ], "x-gdc-security-info": { "description": "Contains permissions required to manipulate the Organization.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/agents": { "get": { "operationId": "getAllEntities@Agents", "parameters": [ { "description": "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').", "example": "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy,userGroups", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "userGroups", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAgentOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAgentOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Agent entities", "tags": [ "Other" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "post": { "description": "AI Agent - behavior configuration for AI assistants", "operationId": "createEntity@Agents", "parameters": [ { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy,userGroups", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "userGroups", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAgentInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAgentInDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAgentOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAgentOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Agent entities", "tags": [ "Other" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/agents/{id}": { "delete": { "operationId": "deleteEntity@Agents", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete Agent entity", "tags": [ "Other" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "get": { "operationId": "getEntity@Agents", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy,userGroups", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "userGroups", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAgentOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAgentOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get Agent entity", "tags": [ "Other" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "patch": { "operationId": "patchEntity@Agents", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy,userGroups", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "userGroups", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAgentPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAgentPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAgentOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAgentOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch Agent entity", "tags": [ "Other" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "put": { "operationId": "updateEntity@Agents", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "enabled==BooleanValue;name==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy,userGroups", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "userGroups", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAgentInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAgentInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAgentOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAgentOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put Agent entity", "tags": [ "Other" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/colorPalettes": { "get": { "operationId": "getAllEntities@ColorPalettes", "parameters": [ { "description": "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').", "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiColorPaletteOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiColorPaletteOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Color Pallettes", "tags": [ "Appearance" ] }, "post": { "operationId": "createEntity@ColorPalettes", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiColorPaletteInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiColorPaletteInDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Color Pallettes", "tags": [ "Appearance" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/colorPalettes/{id}": { "delete": { "operationId": "deleteEntity@ColorPalettes", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete a Color Pallette", "tags": [ "Appearance" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "get": { "operationId": "getEntity@ColorPalettes", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get Color Pallette", "tags": [ "Appearance" ] }, "patch": { "operationId": "patchEntity@ColorPalettes", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiColorPalettePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiColorPalettePatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch Color Pallette", "tags": [ "Appearance" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "put": { "operationId": "updateEntity@ColorPalettes", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiColorPaletteInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiColorPaletteInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiColorPaletteOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put Color Pallette", "tags": [ "Appearance" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/cspDirectives": { "get": { "description": " Context Security Police Directive", "operationId": "getAllEntities@CspDirectives", "parameters": [ { "description": "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').", "example": "sources==v1,v2,v3", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCspDirectiveOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCspDirectiveOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get CSP Directives", "tags": [ "CSP Directives" ] }, "post": { "description": " Context Security Police Directive", "operationId": "createEntity@CspDirectives", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCspDirectiveInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCspDirectiveInDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post CSP Directives", "tags": [ "CSP Directives" ] } }, "/api/v1/entities/cspDirectives/{id}": { "delete": { "description": " Context Security Police Directive", "operationId": "deleteEntity@CspDirectives", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete CSP Directives", "tags": [ "CSP Directives" ] }, "get": { "description": " Context Security Police Directive", "operationId": "getEntity@CspDirectives", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "sources==v1,v2,v3", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get CSP Directives", "tags": [ "CSP Directives" ] }, "patch": { "description": " Context Security Police Directive", "operationId": "patchEntity@CspDirectives", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "sources==v1,v2,v3", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCspDirectivePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCspDirectivePatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch CSP Directives", "tags": [ "CSP Directives" ] }, "put": { "description": " Context Security Police Directive", "operationId": "updateEntity@CspDirectives", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "sources==v1,v2,v3", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCspDirectiveInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCspDirectiveInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCspDirectiveOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put CSP Directives", "tags": [ "CSP Directives" ] } }, "/api/v1/entities/customGeoCollections": { "get": { "operationId": "getAllEntities@CustomGeoCollections", "parameters": [ { "description": "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').", "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Custom Geo Collections", "tags": [ "Other" ] }, "post": { "operationId": "createEntity@CustomGeoCollections", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomGeoCollectionInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomGeoCollectionInDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Custom Geo Collections", "tags": [ "Other" ] } }, "/api/v1/entities/customGeoCollections/{id}": { "delete": { "operationId": "deleteEntity@CustomGeoCollections", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete Custom Geo Collection", "tags": [ "Other" ] }, "get": { "operationId": "getEntity@CustomGeoCollections", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get Custom Geo Collection", "tags": [ "Other" ] }, "patch": { "operationId": "patchEntity@CustomGeoCollections", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomGeoCollectionPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomGeoCollectionPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch Custom Geo Collection", "tags": [ "Other" ] }, "put": { "operationId": "updateEntity@CustomGeoCollections", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomGeoCollectionInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomGeoCollectionInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomGeoCollectionOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put Custom Geo Collection", "tags": [ "Other" ] } }, "/api/v1/entities/dataSourceIdentifiers": { "get": { "operationId": "getAllEntities@DataSourceIdentifiers", "parameters": [ { "description": "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').", "example": "name==someString;schema==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", "example": "metaInclude=permissions,page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "permissions", "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Data Source Identifiers", "tags": [ "Data Source - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to use this object type.", "permissions": [ "USE" ] } } }, "/api/v1/entities/dataSourceIdentifiers/{id}": { "get": { "operationId": "getEntity@DataSourceIdentifiers", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;schema==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "Include Meta objects.", "example": "metaInclude=permissions,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "permissions", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get Data Source Identifier", "tags": [ "Data Source - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to use this object type.", "permissions": [ "USE" ] } } }, "/api/v1/entities/dataSources": { "get": { "description": "Data Source - represents data source for the workspace", "operationId": "getAllEntities@DataSources", "parameters": [ { "description": "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').", "example": "name==someString;type==DatabaseTypeValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", "example": "metaInclude=permissions,page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "permissions", "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDataSourceOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiDataSourceOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get Data Source entities", "tags": [ "Data Source - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "MANAGE" ] } }, "post": { "description": "Data Source - represents data source for the workspace", "operationId": "createEntity@DataSources", "parameters": [ { "description": "Include Meta objects.", "example": "metaInclude=permissions,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "permissions", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDataSourceInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiDataSourceInDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Data Sources", "tags": [ "Data Source - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/dataSources/{id}": { "delete": { "description": "Data Source - represents data source for the workspace", "operationId": "deleteEntity@DataSources", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete Data Source entity", "tags": [ "Data Source - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "get": { "description": "Data Source - represents data source for the workspace", "operationId": "getEntity@DataSources", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;type==DatabaseTypeValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "Include Meta objects.", "example": "metaInclude=permissions,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "permissions", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get Data Source entity", "tags": [ "Data Source - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "MANAGE" ] } }, "patch": { "description": "Data Source - represents data source for the workspace", "operationId": "patchEntity@DataSources", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;type==DatabaseTypeValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDataSourcePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiDataSourcePatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch Data Source entity", "tags": [ "Data Source - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "put": { "description": "Data Source - represents data source for the workspace", "operationId": "updateEntity@DataSources", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;type==DatabaseTypeValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDataSourceInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiDataSourceInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiDataSourceOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put Data Source entity", "tags": [ "Data Source - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/entitlements": { "get": { "description": "Space of the shared interest", "operationId": "getAllEntities@Entitlements", "parameters": [ { "description": "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').", "example": "value==someString;expiry==LocalDateValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiEntitlementOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiEntitlementOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get Entitlements", "tags": [ "Entitlement" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/entitlements/{id}": { "get": { "description": "Space of the shared interest", "operationId": "getEntity@Entitlements", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "value==someString;expiry==LocalDateValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiEntitlementOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiEntitlementOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get Entitlement entity", "tags": [ "Entitlement" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/exportTemplates": { "get": { "operationId": "getAllEntities@ExportTemplates", "parameters": [ { "description": "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').", "example": "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiExportTemplateOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiExportTemplateOutList" } } }, "description": "Request successfully processed" } }, "summary": "GET all Export Template entities", "tags": [ "Export templates" ] }, "post": { "operationId": "createEntity@ExportTemplates", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiExportTemplatePostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiExportTemplatePostOptionalIdDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Export Template entities", "tags": [ "Export templates" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/exportTemplates/{id}": { "delete": { "operationId": "deleteEntity@ExportTemplates", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete Export Template entity", "tags": [ "Export templates" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "get": { "operationId": "getEntity@ExportTemplates", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "GET Export Template entity", "tags": [ "Export templates" ] }, "patch": { "operationId": "patchEntity@ExportTemplates", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiExportTemplatePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiExportTemplatePatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch Export Template entity", "tags": [ "Export templates" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "put": { "operationId": "updateEntity@ExportTemplates", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;dashboardSlidesTemplate==DashboardSlidesTemplateValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiExportTemplateInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiExportTemplateInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiExportTemplateOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "PUT Export Template entity", "tags": [ "Export templates" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/identityProviders": { "get": { "operationId": "getAllEntities@IdentityProviders", "parameters": [ { "description": "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').", "example": "identifiers==v1,v2,v3;customClaimMapping==MapValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiIdentityProviderOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiIdentityProviderOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Identity Providers", "tags": [ "Identity Providers" ] }, "post": { "operationId": "createEntity@IdentityProviders", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiIdentityProviderInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiIdentityProviderInDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Identity Providers", "tags": [ "Identity Providers" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/identityProviders/{id}": { "delete": { "operationId": "deleteEntity@IdentityProviders", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete Identity Provider", "tags": [ "Identity Providers" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "get": { "operationId": "getEntity@IdentityProviders", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "identifiers==v1,v2,v3;customClaimMapping==MapValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get Identity Provider", "tags": [ "Identity Providers" ] }, "patch": { "operationId": "patchEntity@IdentityProviders", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "identifiers==v1,v2,v3;customClaimMapping==MapValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiIdentityProviderPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiIdentityProviderPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch Identity Provider", "tags": [ "Identity Providers" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "put": { "operationId": "updateEntity@IdentityProviders", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "identifiers==v1,v2,v3;customClaimMapping==MapValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiIdentityProviderInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiIdentityProviderInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiIdentityProviderOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put Identity Provider", "tags": [ "Identity Providers" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/ipAllowlistPolicies": { "get": { "operationId": "getAllEntities@IpAllowlistPolicies", "parameters": [ { "description": "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').", "example": "allowedSources==v1,v2,v3", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "users,userGroups", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "users", "userGroups", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all IpAllowlistPolicy entities", "tags": [ "Organization - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "post": { "operationId": "createEntity@IpAllowlistPolicies", "parameters": [ { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "users,userGroups", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "users", "userGroups", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyInDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post IpAllowlistPolicy entities", "tags": [ "Organization - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/ipAllowlistPolicies/{id}": { "delete": { "operationId": "deleteEntity@IpAllowlistPolicies", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete IpAllowlistPolicy entity", "tags": [ "Organization - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "get": { "operationId": "getEntity@IpAllowlistPolicies", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "allowedSources==v1,v2,v3", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "users,userGroups", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "users", "userGroups", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get IpAllowlistPolicy entity", "tags": [ "Organization - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "put": { "operationId": "updateEntity@IpAllowlistPolicies", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "allowedSources==v1,v2,v3", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "users,userGroups", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "users", "userGroups", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiIpAllowlistPolicyOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put IpAllowlistPolicy entity", "tags": [ "Organization - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/jwks": { "get": { "description": "Returns all JSON web keys - used to verify JSON web tokens (Jwts)", "operationId": "getAllEntities@Jwks", "parameters": [ { "description": "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').", "example": "content==JwkSpecificationValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiJwkOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiJwkOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Jwks", "tags": [ "JWKS" ] }, "post": { "description": "Creates JSON web key - used to verify JSON web tokens (Jwts)", "operationId": "createEntity@Jwks", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiJwkInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiJwkInDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiJwkOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiJwkOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Jwks", "tags": [ "JWKS" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/jwks/{id}": { "delete": { "description": "Deletes JSON web key - used to verify JSON web tokens (Jwts)", "operationId": "deleteEntity@Jwks", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete Jwk", "tags": [ "JWKS" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "get": { "description": "Returns JSON web key - used to verify JSON web tokens (Jwts)", "operationId": "getEntity@Jwks", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "content==JwkSpecificationValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiJwkOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiJwkOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get Jwk", "tags": [ "JWKS" ] }, "patch": { "description": "Patches JSON web key - used to verify JSON web tokens (Jwts)", "operationId": "patchEntity@Jwks", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "content==JwkSpecificationValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiJwkPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiJwkPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiJwkOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiJwkOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch Jwk", "tags": [ "JWKS" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "put": { "description": "Updates JSON web key - used to verify JSON web tokens (Jwts)", "operationId": "updateEntity@Jwks", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "content==JwkSpecificationValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiJwkInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiJwkInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiJwkOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiJwkOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put Jwk", "tags": [ "JWKS" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/llmEndpoints": { "get": { "deprecated": true, "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", "operationId": "getAllEntities", "responses": { "410": { "description": "Gone" } }, "summary": "Get all LLM endpoint entities (Removed)", "tags": [ "LLM Endpoints" ] }, "post": { "deprecated": true, "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", "operationId": "createEntity", "responses": { "410": { "description": "Gone" } }, "summary": "Post LLM endpoint entities (Removed)", "tags": [ "LLM Endpoints" ] } }, "/api/v1/entities/llmEndpoints/{id}": { "delete": { "deprecated": true, "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", "operationId": "deleteEntity", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "410": { "description": "Gone" } }, "summary": "Delete LLM endpoint entity (Removed)", "tags": [ "LLM Endpoints" ] }, "get": { "deprecated": true, "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", "operationId": "getEntity", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "410": { "description": "Gone" } }, "summary": "Get LLM endpoint entity (Removed)", "tags": [ "LLM Endpoints" ] }, "patch": { "deprecated": true, "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", "operationId": "patchEntity", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "410": { "description": "Gone" } }, "summary": "Patch LLM endpoint entity (Removed)", "tags": [ "LLM Endpoints" ] }, "put": { "deprecated": true, "description": "Permanently removed. Use /api/v1/entities/llmProviders instead. Always returns 410 Gone.", "operationId": "updateEntity", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "410": { "description": "Gone" } }, "summary": "PUT LLM endpoint entity (Removed)", "tags": [ "LLM Endpoints" ] } }, "/api/v1/entities/llmProviders": { "get": { "operationId": "getAllEntities@LlmProviders", "parameters": [ { "description": "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').", "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiLlmProviderOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiLlmProviderOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all LLM Provider entities", "tags": [ "Other" ] }, "post": { "description": "LLM Provider - connection configuration for LLM services", "operationId": "createEntity@LlmProviders", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post LLM Provider entities", "tags": [ "Other" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/llmProviders/{id}": { "delete": { "operationId": "deleteEntity@LlmProviders", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete LLM Provider entity", "tags": [ "Other" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "get": { "operationId": "getEntity@LlmProviders", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get LLM Provider entity", "tags": [ "Other" ] }, "patch": { "operationId": "patchEntity@LlmProviders", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiLlmProviderPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiLlmProviderPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch LLM Provider entity", "tags": [ "Other" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "put": { "operationId": "updateEntity@LlmProviders", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiLlmProviderInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiLlmProviderOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "PUT LLM Provider entity", "tags": [ "Other" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/notificationChannelIdentifiers": { "get": { "operationId": "getAllEntities@NotificationChannelIdentifiers", "parameters": [ { "description": "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').", "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Notification Channel Identifier entities", "tags": [ "Notification Channels" ] } }, "/api/v1/entities/notificationChannelIdentifiers/{id}": { "get": { "operationId": "getEntity@NotificationChannelIdentifiers", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiNotificationChannelIdentifierOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get Notification Channel Identifier entity", "tags": [ "Notification Channels" ] } }, "/api/v1/entities/notificationChannels": { "get": { "operationId": "getAllEntities@NotificationChannels", "parameters": [ { "description": "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').", "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiNotificationChannelOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiNotificationChannelOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Notification Channel entities", "tags": [ "Notification Channels" ] }, "post": { "operationId": "createEntity@NotificationChannels", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiNotificationChannelPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiNotificationChannelPostOptionalIdDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Notification Channel entities", "tags": [ "Notification Channels" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/notificationChannels/{id}": { "delete": { "operationId": "deleteEntity@NotificationChannels", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete Notification Channel entity", "tags": [ "Notification Channels" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "get": { "operationId": "getEntity@NotificationChannels", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get Notification Channel entity", "tags": [ "Notification Channels" ] }, "patch": { "operationId": "patchEntity@NotificationChannels", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiNotificationChannelPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiNotificationChannelPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch Notification Channel entity", "tags": [ "Notification Channels" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "put": { "operationId": "updateEntity@NotificationChannels", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiNotificationChannelInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiNotificationChannelInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiNotificationChannelOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put Notification Channel entity", "tags": [ "Notification Channels" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/orgMemoryItems": { "get": { "operationId": "getAllEntities@OrgMemoryItems", "parameters": [ { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all organization Memory Item entities", "tags": [ "AI" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "post": { "description": "Organization-scoped AI memory item", "operationId": "createEntity@OrgMemoryItems", "parameters": [ { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post organization Memory Item entities", "tags": [ "AI" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/orgMemoryItems/{id}": { "delete": { "operationId": "deleteEntity@OrgMemoryItems", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete an organization Memory Item entity", "tags": [ "AI" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "get": { "operationId": "getEntity@OrgMemoryItems", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get an organization Memory Item entity", "tags": [ "AI" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "patch": { "operationId": "patchEntity@OrgMemoryItems", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiOrgMemoryItemPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiOrgMemoryItemPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch an organization Memory Item entity", "tags": [ "AI" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "put": { "operationId": "updateEntity@OrgMemoryItems", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiOrgMemoryItemInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiOrgMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put an organization Memory Item entity", "tags": [ "AI" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/organization": { "get": { "description": "Gets a basic information about organization.", "operationId": "getOrganization", "parameters": [ { "description": "Return list of permissions available to logged user.", "example": "metaInclude=permissions", "explode": false, "in": "query", "name": "metaInclude", "schema": { "items": { "description": "Available meta objects to include.", "enum": [ "permissions", "all" ], "type": "string" }, "type": "array", "uniqueItems": true } } ], "responses": { "302": { "description": "Redirect to entity URI." } }, "summary": "Get current organization info", "tags": [ "Organization - Entity APIs" ] } }, "/api/v1/entities/organization/workspaceAutomations": { "get": { "operationId": "getAllAutomations@WorkspaceAutomations", "parameters": [ { "description": "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').", "example": "title==someString;description==someString;workspace.id==321;notificationChannel.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "workspace,notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "workspaces", "notificationChannels", "analyticalDashboards", "userIdentifiers", "exportDefinitions", "users", "automationResults", "workspace", "notificationChannel", "analyticalDashboard", "createdBy", "modifiedBy", "recipients", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceAutomationOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Automations across all Workspaces", "tags": [ "Automations" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/organizationSettings": { "get": { "operationId": "getAllEntities@OrganizationSettings", "parameters": [ { "description": "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').", "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationSettingOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get Organization Setting entities", "tags": [ "Organization - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "post": { "operationId": "createEntity@OrganizationSettings", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Organization Setting entities", "tags": [ "Organization - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/organizationSettings/{id}": { "delete": { "operationId": "deleteEntity@OrganizationSettings", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete Organization Setting entity", "tags": [ "Organization - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "get": { "operationId": "getEntity@OrganizationSettings", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get Organization Setting entity", "tags": [ "Organization - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "patch": { "operationId": "patchEntity@OrganizationSettings", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationSettingPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationSettingPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch Organization Setting entity", "tags": [ "Organization - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "put": { "operationId": "updateEntity@OrganizationSettings", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationSettingInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiOrganizationSettingOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put Organization Setting entity", "tags": [ "Organization - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/themes": { "get": { "operationId": "getAllEntities@Themes", "parameters": [ { "description": "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').", "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiThemeOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiThemeOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Theming entities", "tags": [ "Appearance" ] }, "post": { "operationId": "createEntity@Themes", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiThemeInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiThemeInDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiThemeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiThemeOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Theming", "tags": [ "Appearance" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/themes/{id}": { "delete": { "operationId": "deleteEntity@Themes", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete Theming", "tags": [ "Appearance" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "get": { "operationId": "getEntity@Themes", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiThemeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiThemeOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get Theming", "tags": [ "Appearance" ] }, "patch": { "operationId": "patchEntity@Themes", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiThemePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiThemePatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiThemeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiThemeOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch Theming", "tags": [ "Appearance" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "put": { "operationId": "updateEntity@Themes", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiThemeInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiThemeInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiThemeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiThemeOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put Theming", "tags": [ "Appearance" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/userGroups": { "get": { "description": "User Group - creates tree-like structure for categorizing users", "operationId": "getAllEntities@UserGroups", "parameters": [ { "description": "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').", "example": "name==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "parents", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userGroups", "parents", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserGroupOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserGroupOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get UserGroup entities", "tags": [ "UserGroups - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "post": { "description": "User Group - creates tree-like structure for categorizing users", "operationId": "createEntity@UserGroups", "parameters": [ { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "parents", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userGroups", "parents", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserGroupInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserGroupInDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post User Group entities", "tags": [ "UserGroups - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/userGroups/{id}": { "delete": { "description": "User Group - creates tree-like structure for categorizing users", "operationId": "deleteEntity@UserGroups", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete UserGroup entity", "tags": [ "UserGroups - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "get": { "description": "User Group - creates tree-like structure for categorizing users", "operationId": "getEntity@UserGroups", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "parents", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userGroups", "parents", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get UserGroup entity", "tags": [ "UserGroups - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "patch": { "description": "User Group - creates tree-like structure for categorizing users", "operationId": "patchEntity@UserGroups", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "parents", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userGroups", "parents", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserGroupPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserGroupPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch UserGroup entity", "tags": [ "UserGroups - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "put": { "description": "User Group - creates tree-like structure for categorizing users", "operationId": "updateEntity@UserGroups", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "parents", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userGroups", "parents", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserGroupInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserGroupInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserGroupOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put UserGroup entity", "tags": [ "UserGroups - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/userIdentifiers": { "get": { "description": "UserIdentifier - represents entity interacting with platform", "operationId": "getAllEntities@UserIdentifiers", "parameters": [ { "description": "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').", "example": "firstname==someString;lastname==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserIdentifierOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserIdentifierOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get UserIdentifier entities", "tags": [ "User Identifiers" ] } }, "/api/v1/entities/userIdentifiers/{id}": { "get": { "description": "UserIdentifier - represents basic information about entity interacting with platform", "operationId": "getEntity@UserIdentifiers", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "firstname==someString;lastname==someString", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserIdentifierOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserIdentifierOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get UserIdentifier entity", "tags": [ "User Identifiers" ] } }, "/api/v1/entities/users": { "get": { "description": "User - represents entity interacting with platform", "operationId": "getAllEntities@Users", "parameters": [ { "description": "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').", "example": "authenticationId==someString;firstname==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "userGroups", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userGroups", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get User entities", "tags": [ "Users - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "post": { "description": "User - represents entity interacting with platform", "operationId": "createEntity@Users", "parameters": [ { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "userGroups", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userGroups", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserInDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post User entities", "tags": [ "Users - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/users/{id}": { "delete": { "description": "User - represents entity interacting with platform", "operationId": "deleteEntity@Users", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete User entity", "tags": [ "Users - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "get": { "description": "User - represents entity interacting with platform", "operationId": "getEntity@Users", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "authenticationId==someString;firstname==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "userGroups", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userGroups", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get User entity", "tags": [ "Users - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "patch": { "description": "User - represents entity interacting with platform", "operationId": "patchEntity@Users", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "authenticationId==someString;firstname==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "userGroups", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userGroups", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch User entity", "tags": [ "Users - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "put": { "description": "User - represents entity interacting with platform", "operationId": "updateEntity@Users", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "authenticationId==someString;firstname==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "userGroups", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userGroups", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put User entity", "tags": [ "Users - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/users/{userId}/apiTokens": { "get": { "operationId": "getAllEntities@ApiTokens", "parameters": [ { "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "bearerToken==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiApiTokenOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiApiTokenOutList" } } }, "description": "Request successfully processed" } }, "summary": "List all api tokens for a user", "tags": [ "API tokens" ] }, "post": { "operationId": "createEntity@ApiTokens", "parameters": [ { "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiApiTokenInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiApiTokenInDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post a new API token for the user", "tags": [ "API tokens" ] } }, "/api/v1/entities/users/{userId}/apiTokens/{id}": { "delete": { "operationId": "deleteEntity@ApiTokens", "parameters": [ { "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idPathParameter" } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete an API Token for a user", "tags": [ "API tokens" ] }, "get": { "operationId": "getEntity@ApiTokens", "parameters": [ { "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "bearerToken==someString", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiApiTokenOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get an API Token for a user", "tags": [ "API tokens" ] } }, "/api/v1/entities/users/{userId}/customUserApplicationSettings": { "get": { "operationId": "getAllEntities@CustomUserApplicationSettings", "parameters": [ { "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "applicationName==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutList" } } }, "description": "Request successfully processed" } }, "summary": "List all custom application settings for a user", "tags": [ "User Settings" ] }, "post": { "operationId": "createEntity@CustomUserApplicationSettings", "parameters": [ { "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingPostOptionalIdDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post a new custom application setting for the user", "tags": [ "User Settings" ] } }, "/api/v1/entities/users/{userId}/customUserApplicationSettings/{id}": { "delete": { "operationId": "deleteEntity@CustomUserApplicationSettings", "parameters": [ { "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idPathParameter" } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete a custom application setting for a user", "tags": [ "User Settings" ] }, "get": { "operationId": "getEntity@CustomUserApplicationSettings", "parameters": [ { "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "applicationName==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get a custom application setting for a user", "tags": [ "User Settings" ] }, "put": { "operationId": "updateEntity@CustomUserApplicationSettings", "parameters": [ { "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "applicationName==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomUserApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put a custom application setting for the user", "tags": [ "User Settings" ] } }, "/api/v1/entities/users/{userId}/userSettings": { "get": { "operationId": "getAllEntities@UserSettings", "parameters": [ { "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserSettingOutList" } } }, "description": "Request successfully processed" } }, "summary": "List all settings for a user", "tags": [ "User Settings" ] }, "post": { "operationId": "createEntity@UserSettings", "parameters": [ { "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserSettingInDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post new user settings for the user", "tags": [ "User Settings" ] } }, "/api/v1/entities/users/{userId}/userSettings/{id}": { "delete": { "operationId": "deleteEntity@UserSettings", "parameters": [ { "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idPathParameter" } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete a setting for a user", "tags": [ "User Settings" ] }, "get": { "operationId": "getEntity@UserSettings", "parameters": [ { "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get a setting for a user", "tags": [ "User Settings" ] }, "put": { "operationId": "updateEntity@UserSettings", "parameters": [ { "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserSettingInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserSettingOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put new user settings for the user", "tags": [ "User Settings" ] } }, "/api/v1/entities/workspaces": { "get": { "description": "Space of the shared interest", "operationId": "getAllEntities@Workspaces", "parameters": [ { "description": "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').", "example": "name==someString;earlyAccess==someString;parent.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "parent", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "workspaces", "parent", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "description": "Include Meta objects.", "example": "metaInclude=permissions,config,hierarchy,dataModelDatasets,page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "permissions", "config", "hierarchy", "dataModelDatasets", "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get Workspace entities", "tags": [ "Workspaces - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "post": { "description": "Space of the shared interest", "operationId": "createEntity@Workspaces", "parameters": [ { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "parent", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "workspaces", "parent", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Include Meta objects.", "example": "metaInclude=permissions,config,hierarchy,dataModelDatasets,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "permissions", "config", "hierarchy", "dataModelDatasets", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Workspace entities", "tags": [ "Workspaces - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/workspaces/{id}": { "delete": { "description": "Space of the shared interest", "operationId": "deleteEntity@Workspaces", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete Workspace entity", "tags": [ "Workspaces - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "get": { "description": "Space of the shared interest", "operationId": "getEntity@Workspaces", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;earlyAccess==someString;parent.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "parent", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "workspaces", "parent", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Include Meta objects.", "example": "metaInclude=permissions,config,hierarchy,dataModelDatasets,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "permissions", "config", "hierarchy", "dataModelDatasets", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get Workspace entity", "tags": [ "Workspaces - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "patch": { "description": "Space of the shared interest", "operationId": "patchEntity@Workspaces", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;earlyAccess==someString;parent.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "parent", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "workspaces", "parent", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspacePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspacePatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch Workspace entity", "tags": [ "Workspaces - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "put": { "description": "Space of the shared interest", "operationId": "updateEntity@Workspaces", "parameters": [ { "$ref": "#/components/parameters/idPathParameter" }, { "description": "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').", "example": "name==someString;earlyAccess==someString;parent.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "parent", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "workspaces", "parent", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put Workspace entity", "tags": [ "Workspaces - Entity APIs" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts": { "get": { "operationId": "getAllEntities@AggregatedFacts", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "description": "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').", "example": "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "dataset,sourceFact,sourceAttribute", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "datasets", "facts", "attributes", "dataset", "sourceFact", "sourceAttribute", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Aggregated Facts", "tags": [ "Facts" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/search": { "post": { "operationId": "searchEntities@AggregatedFacts", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchBody" } } }, "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAggregatedFactOutList" } } }, "description": "Request successfully processed" } }, "summary": "The search endpoint (beta)", "tags": [ "Facts" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/aggregatedFacts/{objectId}": { "get": { "operationId": "getEntity@AggregatedFacts", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "description==someString;tags==v1,v2,v3;dataset.id==321;sourceFact.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "dataset,sourceFact,sourceAttribute", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "datasets", "facts", "attributes", "dataset", "sourceFact", "sourceAttribute", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAggregatedFactOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAggregatedFactOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get an Aggregated Fact", "tags": [ "Facts" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards": { "get": { "operationId": "getAllEntities@AnalyticalDashboards", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "visualizationObjects", "analyticalDashboards", "labels", "metrics", "parameters", "datasets", "filterContexts", "dashboardPlugins", "createdBy", "modifiedBy", "certifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=permissions,origin,accessInfo,page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "permissions", "origin", "accessInfo", "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Dashboards", "tags": [ "Dashboards" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "post": { "operationId": "createEntity@AnalyticalDashboards", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "visualizationObjects", "analyticalDashboards", "labels", "metrics", "parameters", "datasets", "filterContexts", "dashboardPlugins", "createdBy", "modifiedBy", "certifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Include Meta objects.", "example": "metaInclude=permissions,origin,accessInfo,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "permissions", "origin", "accessInfo", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPostOptionalIdDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Dashboards", "tags": [ "Dashboards" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "ANALYZE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/search": { "post": { "operationId": "searchEntities@AnalyticalDashboards", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchBody" } } }, "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutList" } } }, "description": "Request successfully processed" } }, "summary": "The search endpoint (beta)", "tags": [ "Dashboards" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/analyticalDashboards/{objectId}": { "delete": { "operationId": "deleteEntity@AnalyticalDashboards", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete a Dashboard", "tags": [ "Dashboards" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "ANALYZE" ] } }, "get": { "operationId": "getEntity@AnalyticalDashboards", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "visualizationObjects", "analyticalDashboards", "labels", "metrics", "parameters", "datasets", "filterContexts", "dashboardPlugins", "createdBy", "modifiedBy", "certifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=permissions,origin,accessInfo,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "permissions", "origin", "accessInfo", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get a Dashboard", "tags": [ "Dashboards" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "patch": { "operationId": "patchEntity@AnalyticalDashboards", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "visualizationObjects", "analyticalDashboards", "labels", "metrics", "parameters", "datasets", "filterContexts", "dashboardPlugins", "createdBy", "modifiedBy", "certifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch a Dashboard", "tags": [ "Dashboards" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "ANALYZE" ] } }, "put": { "operationId": "updateEntity@AnalyticalDashboards", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy,certifiedBy,visualizationObjects,analyticalDashboards,labels,metrics,parameters,datasets,filterContexts,dashboardPlugins", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "visualizationObjects", "analyticalDashboards", "labels", "metrics", "parameters", "datasets", "filterContexts", "dashboardPlugins", "createdBy", "modifiedBy", "certifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put Dashboards", "tags": [ "Dashboards" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "ANALYZE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies": { "get": { "operationId": "getAllEntities@AttributeHierarchies", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy,attributes", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "attributes", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Attribute Hierarchies", "tags": [ "Attribute Hierarchies" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "post": { "operationId": "createEntity@AttributeHierarchies", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy,attributes", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "attributes", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Attribute Hierarchies", "tags": [ "Attribute Hierarchies" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "ANALYZE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/search": { "post": { "operationId": "searchEntities@AttributeHierarchies", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchBody" } } }, "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutList" } } }, "description": "Request successfully processed" } }, "summary": "The search endpoint (beta)", "tags": [ "Attribute Hierarchies" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/attributeHierarchies/{objectId}": { "delete": { "operationId": "deleteEntity@AttributeHierarchies", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete an Attribute Hierarchy", "tags": [ "Attribute Hierarchies" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "ANALYZE" ] } }, "get": { "operationId": "getEntity@AttributeHierarchies", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy,attributes", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "attributes", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get an Attribute Hierarchy", "tags": [ "Attribute Hierarchies" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "patch": { "operationId": "patchEntity@AttributeHierarchies", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy,attributes", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "attributes", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch an Attribute Hierarchy", "tags": [ "Attribute Hierarchies" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "ANALYZE" ] } }, "put": { "operationId": "updateEntity@AttributeHierarchies", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy,attributes", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "attributes", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put an Attribute Hierarchy", "tags": [ "Attribute Hierarchies" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "ANALYZE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/attributes": { "get": { "operationId": "getAllEntities@Attributes", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;dataset.id==321;defaultView.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "dataset,defaultView,labels,attributeHierarchies", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "datasets", "labels", "attributeHierarchies", "dataset", "defaultView", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Attributes", "tags": [ "Attributes" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/attributes/search": { "post": { "operationId": "searchEntities@Attributes", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchBody" } } }, "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeOutList" } } }, "description": "Request successfully processed" } }, "summary": "The search endpoint (beta)", "tags": [ "Attributes" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/attributes/{objectId}": { "get": { "operationId": "getEntity@Attributes", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;dataset.id==321;defaultView.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "dataset,defaultView,labels,attributeHierarchies", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "datasets", "labels", "attributeHierarchies", "dataset", "defaultView", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get an Attribute", "tags": [ "Attributes" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "patch": { "operationId": "patchEntity@Attributes", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;dataset.id==321;defaultView.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "dataset,defaultView,labels,attributeHierarchies", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "datasets", "labels", "attributeHierarchies", "dataset", "defaultView", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributePatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributePatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAttributeOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch an Attribute (beta)", "tags": [ "Attributes" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/automationResults/search": { "post": { "operationId": "searchEntities@AutomationResults", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchBody" } } }, "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAutomationResultOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAutomationResultOutList" } } }, "description": "Request successfully processed" } }, "summary": "The search endpoint (beta)", "tags": [ "Automations" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/automations": { "get": { "operationId": "getAllEntities@Automations", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "notificationChannels", "analyticalDashboards", "userIdentifiers", "exportDefinitions", "users", "automationResults", "notificationChannel", "analyticalDashboard", "createdBy", "modifiedBy", "recipients", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAutomationOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAutomationOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Automations", "tags": [ "Automations" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "post": { "operationId": "createEntity@Automations", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "notificationChannels", "analyticalDashboards", "userIdentifiers", "exportDefinitions", "users", "automationResults", "notificationChannel", "analyticalDashboard", "createdBy", "modifiedBy", "recipients", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAutomationInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAutomationInDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Automations", "tags": [ "Automations" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "CREATE_AUTOMATION" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/automations/search": { "post": { "operationId": "searchEntities@Automations", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchBody" } } }, "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAutomationOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAutomationOutList" } } }, "description": "Request successfully processed" } }, "summary": "The search endpoint (beta)", "tags": [ "Automations" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/automations/{objectId}": { "delete": { "operationId": "deleteEntity@Automations", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete an Automation", "tags": [ "Automations" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "CREATE_AUTOMATION" ] } }, "get": { "operationId": "getEntity@Automations", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "notificationChannels", "analyticalDashboards", "userIdentifiers", "exportDefinitions", "users", "automationResults", "notificationChannel", "analyticalDashboard", "createdBy", "modifiedBy", "recipients", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get an Automation", "tags": [ "Automations" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "patch": { "operationId": "patchEntity@Automations", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "notificationChannels", "analyticalDashboards", "userIdentifiers", "exportDefinitions", "users", "automationResults", "notificationChannel", "analyticalDashboard", "createdBy", "modifiedBy", "recipients", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAutomationPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAutomationPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch an Automation", "tags": [ "Automations" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "CREATE_AUTOMATION" ] } }, "put": { "operationId": "updateEntity@Automations", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;notificationChannel.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "notificationChannel,analyticalDashboard,createdBy,modifiedBy,exportDefinitions,recipients,automationResults", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "notificationChannels", "analyticalDashboards", "userIdentifiers", "exportDefinitions", "users", "automationResults", "notificationChannel", "analyticalDashboard", "createdBy", "modifiedBy", "recipients", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAutomationInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAutomationInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiAutomationOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put an Automation", "tags": [ "Automations" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "CREATE_AUTOMATION" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings": { "get": { "operationId": "getAllEntities@CustomApplicationSettings", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "description": "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').", "example": "applicationName==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Custom Application Settings", "tags": [ "Workspaces - Settings" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "post": { "operationId": "createEntity@CustomApplicationSettings", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPostOptionalIdDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Custom Application Settings", "tags": [ "Workspaces - Settings" ] } }, "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/search": { "post": { "operationId": "searchEntities@CustomApplicationSettings", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchBody" } } }, "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutList" } } }, "description": "Request successfully processed" } }, "summary": "The search endpoint (beta)", "tags": [ "Workspaces - Settings" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/customApplicationSettings/{objectId}": { "delete": { "operationId": "deleteEntity@CustomApplicationSettings", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete a Custom Application Setting", "tags": [ "Workspaces - Settings" ] }, "get": { "operationId": "getEntity@CustomApplicationSettings", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "applicationName==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get a Custom Application Setting", "tags": [ "Workspaces - Settings" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "patch": { "operationId": "patchEntity@CustomApplicationSettings", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "applicationName==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch a Custom Application Setting", "tags": [ "Workspaces - Settings" ] }, "put": { "operationId": "updateEntity@CustomApplicationSettings", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "applicationName==someString;content==JsonNodeValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomApplicationSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomApplicationSettingInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put a Custom Application Setting", "tags": [ "Workspaces - Settings" ] } }, "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins": { "get": { "operationId": "getAllEntities@DashboardPlugins", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Plugins", "tags": [ "Plugins" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "post": { "operationId": "createEntity@DashboardPlugins", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDashboardPluginPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiDashboardPluginPostOptionalIdDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Plugins", "tags": [ "Plugins" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "ANALYZE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/search": { "post": { "operationId": "searchEntities@DashboardPlugins", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchBody" } } }, "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiDashboardPluginOutList" } } }, "description": "Request successfully processed" } }, "summary": "The search endpoint (beta)", "tags": [ "Plugins" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/dashboardPlugins/{objectId}": { "delete": { "operationId": "deleteEntity@DashboardPlugins", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete a Plugin", "tags": [ "Plugins" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "ANALYZE" ] } }, "get": { "operationId": "getEntity@DashboardPlugins", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get a Plugin", "tags": [ "Plugins" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "patch": { "operationId": "patchEntity@DashboardPlugins", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDashboardPluginPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiDashboardPluginPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch a Plugin", "tags": [ "Plugins" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "ANALYZE" ] } }, "put": { "operationId": "updateEntity@DashboardPlugins", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDashboardPluginInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiDashboardPluginInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiDashboardPluginOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put a Plugin", "tags": [ "Plugins" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "ANALYZE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/datasets": { "get": { "operationId": "getAllEntities@Datasets", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "attributes,facts,aggregatedFacts,references,workspaceDataFilters", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "attributes", "facts", "aggregatedFacts", "datasets", "workspaceDataFilters", "references", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDatasetOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiDatasetOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Datasets", "tags": [ "Datasets" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/datasets/search": { "post": { "operationId": "searchEntities@Datasets", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchBody" } } }, "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDatasetOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiDatasetOutList" } } }, "description": "Request successfully processed" } }, "summary": "The search endpoint (beta)", "tags": [ "Datasets" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/datasets/{objectId}": { "get": { "operationId": "getEntity@Datasets", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "attributes,facts,aggregatedFacts,references,workspaceDataFilters", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "attributes", "facts", "aggregatedFacts", "datasets", "workspaceDataFilters", "references", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDatasetOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiDatasetOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get a Dataset", "tags": [ "Datasets" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "patch": { "operationId": "patchEntity@Datasets", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "attributes,facts,aggregatedFacts,references,workspaceDataFilters", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "attributes", "facts", "aggregatedFacts", "datasets", "workspaceDataFilters", "references", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDatasetPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiDatasetPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiDatasetOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiDatasetOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch a Dataset (beta)", "tags": [ "Datasets" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/exportDefinitions": { "get": { "operationId": "getAllEntities@ExportDefinitions", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "visualizationObjects", "analyticalDashboards", "automations", "userIdentifiers", "visualizationObject", "analyticalDashboard", "automation", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiExportDefinitionOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiExportDefinitionOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Export Definitions", "tags": [ "Export Definitions" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "post": { "operationId": "createEntity@ExportDefinitions", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "visualizationObjects", "analyticalDashboards", "automations", "userIdentifiers", "visualizationObject", "analyticalDashboard", "automation", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiExportDefinitionPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiExportDefinitionPostOptionalIdDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Export Definitions", "tags": [ "Export Definitions" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "ANALYZE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/search": { "post": { "operationId": "searchEntities@ExportDefinitions", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchBody" } } }, "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiExportDefinitionOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiExportDefinitionOutList" } } }, "description": "Request successfully processed" } }, "summary": "The search endpoint (beta)", "tags": [ "Export Definitions" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/exportDefinitions/{objectId}": { "delete": { "operationId": "deleteEntity@ExportDefinitions", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete an Export Definition", "tags": [ "Export Definitions" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "ANALYZE" ] } }, "get": { "operationId": "getEntity@ExportDefinitions", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "visualizationObjects", "analyticalDashboards", "automations", "userIdentifiers", "visualizationObject", "analyticalDashboard", "automation", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get an Export Definition", "tags": [ "Export Definitions" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "patch": { "operationId": "patchEntity@ExportDefinitions", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "visualizationObjects", "analyticalDashboards", "automations", "userIdentifiers", "visualizationObject", "analyticalDashboard", "automation", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiExportDefinitionPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiExportDefinitionPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch an Export Definition", "tags": [ "Export Definitions" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "ANALYZE" ] } }, "put": { "operationId": "updateEntity@ExportDefinitions", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;visualizationObject.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "visualizationObject,analyticalDashboard,automation,createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "visualizationObjects", "analyticalDashboards", "automations", "userIdentifiers", "visualizationObject", "analyticalDashboard", "automation", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiExportDefinitionInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiExportDefinitionInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiExportDefinitionOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put an Export Definition", "tags": [ "Export Definitions" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "ANALYZE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/facts": { "get": { "operationId": "getAllEntities@Facts", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;dataset.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "dataset", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "datasets", "dataset", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiFactOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiFactOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Facts", "tags": [ "Facts" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/facts/search": { "post": { "operationId": "searchEntities@Facts", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchBody" } } }, "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiFactOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiFactOutList" } } }, "description": "Request successfully processed" } }, "summary": "The search endpoint (beta)", "tags": [ "Facts" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/facts/{objectId}": { "get": { "operationId": "getEntity@Facts", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;dataset.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "dataset", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "datasets", "dataset", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiFactOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiFactOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get a Fact", "tags": [ "Facts" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "patch": { "operationId": "patchEntity@Facts", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;dataset.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "dataset", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "datasets", "dataset", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiFactPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiFactPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiFactOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiFactOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch a Fact (beta)", "tags": [ "Facts" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/filterContexts": { "get": { "operationId": "getAllEntities@FilterContexts", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "attributes,datasets,labels", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "attributes", "datasets", "labels", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterContextOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterContextOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Filter Context", "tags": [ "Filter Context" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "post": { "operationId": "createEntity@FilterContexts", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "attributes,datasets,labels", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "attributes", "datasets", "labels", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterContextPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterContextPostOptionalIdDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Filter Context", "tags": [ "Filter Context" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "ANALYZE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/filterContexts/search": { "post": { "operationId": "searchEntities@FilterContexts", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchBody" } } }, "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterContextOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterContextOutList" } } }, "description": "Request successfully processed" } }, "summary": "The search endpoint (beta)", "tags": [ "Filter Context" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/filterContexts/{objectId}": { "delete": { "operationId": "deleteEntity@FilterContexts", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete a Filter Context", "tags": [ "Filter Context" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "ANALYZE" ] } }, "get": { "operationId": "getEntity@FilterContexts", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "attributes,datasets,labels", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "attributes", "datasets", "labels", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get a Filter Context", "tags": [ "Filter Context" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "patch": { "operationId": "patchEntity@FilterContexts", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "attributes,datasets,labels", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "attributes", "datasets", "labels", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterContextPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterContextPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch a Filter Context", "tags": [ "Filter Context" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "ANALYZE" ] } }, "put": { "operationId": "updateEntity@FilterContexts", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "attributes,datasets,labels", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "attributes", "datasets", "labels", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterContextInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterContextInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterContextOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put a Filter Context", "tags": [ "Filter Context" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "ANALYZE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/filterViews": { "get": { "operationId": "getAllEntities@FilterViews", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "analyticalDashboard,user", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "analyticalDashboards", "users", "analyticalDashboard", "user", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterViewOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterViewOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Filter views", "tags": [ "Filter Views" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "post": { "operationId": "createEntity@FilterViews", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "analyticalDashboard,user", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "analyticalDashboards", "users", "analyticalDashboard", "user", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterViewInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterViewInDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Filter views", "tags": [ "Filter Views" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage Filter Views", "permissions": [ "CREATE_FILTER_VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/filterViews/search": { "post": { "operationId": "searchEntities@FilterViews", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchBody" } } }, "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterViewOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterViewOutList" } } }, "description": "Request successfully processed" } }, "summary": "The search endpoint (beta)", "tags": [ "Filter Views" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/filterViews/{objectId}": { "delete": { "operationId": "deleteEntity@FilterViews", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete Filter view", "tags": [ "Filter Views" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage Filter Views", "permissions": [ "CREATE_FILTER_VIEW" ] } }, "get": { "operationId": "getEntity@FilterViews", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "analyticalDashboard,user", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "analyticalDashboards", "users", "analyticalDashboard", "user", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get Filter view", "tags": [ "Filter Views" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "patch": { "operationId": "patchEntity@FilterViews", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "analyticalDashboard,user", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "analyticalDashboards", "users", "analyticalDashboard", "user", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterViewPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterViewPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch Filter view", "tags": [ "Filter Views" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage Filter Views", "permissions": [ "CREATE_FILTER_VIEW" ] } }, "put": { "operationId": "updateEntity@FilterViews", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;analyticalDashboard.id==321;user.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "analyticalDashboard,user", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "analyticalDashboards", "users", "analyticalDashboard", "user", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterViewInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterViewInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiFilterViewOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put Filter views", "tags": [ "Filter Views" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage Filter Views", "permissions": [ "CREATE_FILTER_VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations": { "get": { "operationId": "getAllEntities@KnowledgeRecommendations", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "metric,analyticalDashboard", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "metrics", "analyticalDashboards", "metric", "analyticalDashboard", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Knowledge Recommendations", "tags": [ "AI" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "post": { "operationId": "createEntity@KnowledgeRecommendations", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "metric,analyticalDashboard", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "metrics", "analyticalDashboards", "metric", "analyticalDashboard", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPostOptionalIdDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Knowledge Recommendations", "tags": [ "AI" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/search": { "post": { "operationId": "searchEntities@KnowledgeRecommendations", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchBody" } } }, "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutList" } } }, "description": "Request successfully processed" } }, "summary": "The search endpoint (beta)", "tags": [ "AI" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/knowledgeRecommendations/{objectId}": { "delete": { "operationId": "deleteEntity@KnowledgeRecommendations", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete a Knowledge Recommendation", "tags": [ "AI" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "get": { "operationId": "getEntity@KnowledgeRecommendations", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "metric,analyticalDashboard", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "metrics", "analyticalDashboards", "metric", "analyticalDashboard", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get a Knowledge Recommendation", "tags": [ "AI" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "patch": { "operationId": "patchEntity@KnowledgeRecommendations", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "metric,analyticalDashboard", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "metrics", "analyticalDashboards", "metric", "analyticalDashboard", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch a Knowledge Recommendation", "tags": [ "AI" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "put": { "operationId": "updateEntity@KnowledgeRecommendations", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;metric.id==321;analyticalDashboard.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "metric,analyticalDashboard", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "metrics", "analyticalDashboards", "metric", "analyticalDashboard", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiKnowledgeRecommendationOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put a Knowledge Recommendation", "tags": [ "AI" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/labels": { "get": { "operationId": "getAllEntities@Labels", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;attribute.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "attribute", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "attributes", "attribute", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiLabelOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiLabelOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Labels", "tags": [ "Labels" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/labels/search": { "post": { "operationId": "searchEntities@Labels", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchBody" } } }, "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiLabelOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiLabelOutList" } } }, "description": "Request successfully processed" } }, "summary": "The search endpoint (beta)", "tags": [ "Labels" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/labels/{objectId}": { "get": { "operationId": "getEntity@Labels", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;attribute.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "attribute", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "attributes", "attribute", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiLabelOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiLabelOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get a Label", "tags": [ "Labels" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "patch": { "operationId": "patchEntity@Labels", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;attribute.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "attribute", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "attributes", "attribute", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiLabelPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiLabelPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiLabelOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiLabelOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch a Label (beta)", "tags": [ "Labels" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/memoryItems": { "get": { "operationId": "getAllEntities@MemoryItems", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiMemoryItemOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiMemoryItemOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Memory Items", "tags": [ "AI" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "post": { "operationId": "createEntity@MemoryItems", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiMemoryItemPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiMemoryItemPostOptionalIdDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Memory Items", "tags": [ "AI" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/memoryItems/search": { "post": { "operationId": "searchEntities@MemoryItems", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchBody" } } }, "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiMemoryItemOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiMemoryItemOutList" } } }, "description": "Request successfully processed" } }, "summary": "The search endpoint (beta)", "tags": [ "AI" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/memoryItems/{objectId}": { "delete": { "operationId": "deleteEntity@MemoryItems", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete a Memory Item", "tags": [ "AI" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "get": { "operationId": "getEntity@MemoryItems", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get a Memory Item", "tags": [ "AI" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "patch": { "operationId": "patchEntity@MemoryItems", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiMemoryItemPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiMemoryItemPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch a Memory Item", "tags": [ "AI" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "put": { "operationId": "updateEntity@MemoryItems", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiMemoryItemInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiMemoryItemInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiMemoryItemOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put a Memory Item", "tags": [ "AI" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/metrics": { "get": { "operationId": "getAllEntities@Metrics", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "facts", "attributes", "labels", "metrics", "datasets", "parameters", "createdBy", "modifiedBy", "certifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiMetricOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiMetricOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Metrics", "tags": [ "Metrics" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "post": { "operationId": "createEntity@Metrics", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "facts", "attributes", "labels", "metrics", "datasets", "parameters", "createdBy", "modifiedBy", "certifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiMetricPostOptionalIdDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiMetricOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiMetricOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Metrics", "tags": [ "Metrics" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/metrics/search": { "post": { "operationId": "searchEntities@Metrics", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchBody" } } }, "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiMetricOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiMetricOutList" } } }, "description": "Request successfully processed" } }, "summary": "The search endpoint (beta)", "tags": [ "Metrics" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/metrics/{objectId}": { "delete": { "operationId": "deleteEntity@Metrics", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete a Metric", "tags": [ "Metrics" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "get": { "operationId": "getEntity@Metrics", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "facts", "attributes", "labels", "metrics", "datasets", "parameters", "createdBy", "modifiedBy", "certifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiMetricOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiMetricOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get a Metric", "tags": [ "Metrics" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "patch": { "operationId": "patchEntity@Metrics", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "facts", "attributes", "labels", "metrics", "datasets", "parameters", "createdBy", "modifiedBy", "certifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiMetricPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiMetricPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiMetricOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiMetricOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch a Metric", "tags": [ "Metrics" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "put": { "operationId": "updateEntity@Metrics", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "facts", "attributes", "labels", "metrics", "datasets", "parameters", "createdBy", "modifiedBy", "certifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiMetricInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiMetricInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiMetricOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiMetricOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put a Metric", "tags": [ "Metrics" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/parameters": { "get": { "operationId": "getAllEntities@Parameters", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiParameterOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiParameterOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Parameters", "tags": [ "Parameters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "post": { "operationId": "createEntity@Parameters", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiParameterPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiParameterPostOptionalIdDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiParameterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiParameterOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Parameters", "tags": [ "Parameters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/parameters/search": { "post": { "operationId": "searchEntities@Parameters", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchBody" } } }, "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiParameterOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiParameterOutList" } } }, "description": "Request successfully processed" } }, "summary": "The search endpoint (beta)", "tags": [ "Parameters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/parameters/{objectId}": { "delete": { "operationId": "deleteEntity@Parameters", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete a Parameter", "tags": [ "Parameters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "get": { "operationId": "getEntity@Parameters", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiParameterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiParameterOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get a Parameter", "tags": [ "Parameters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "patch": { "operationId": "patchEntity@Parameters", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiParameterPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiParameterPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiParameterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiParameterOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch a Parameter", "tags": [ "Parameters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "put": { "operationId": "updateEntity@Parameters", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "createdBy", "modifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiParameterInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiParameterInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiParameterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiParameterOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put a Parameter", "tags": [ "Parameters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/userDataFilters": { "get": { "operationId": "getAllEntities@UserDataFilters", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;user.id==321;userGroup.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "users", "userGroups", "facts", "attributes", "labels", "metrics", "datasets", "parameters", "user", "userGroup", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserDataFilterOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserDataFilterOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all User Data Filters", "tags": [ "Data Filters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "post": { "operationId": "createEntity@UserDataFilters", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "users", "userGroups", "facts", "attributes", "labels", "metrics", "datasets", "parameters", "user", "userGroup", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserDataFilterPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserDataFilterPostOptionalIdDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post User Data Filters", "tags": [ "Data Filters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/userDataFilters/search": { "post": { "operationId": "searchEntities@UserDataFilters", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchBody" } } }, "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserDataFilterOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserDataFilterOutList" } } }, "description": "Request successfully processed" } }, "summary": "The search endpoint (beta)", "tags": [ "Data Filters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/userDataFilters/{objectId}": { "delete": { "operationId": "deleteEntity@UserDataFilters", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete a User Data Filter", "tags": [ "Data Filters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "get": { "operationId": "getEntity@UserDataFilters", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;user.id==321;userGroup.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "users", "userGroups", "facts", "attributes", "labels", "metrics", "datasets", "parameters", "user", "userGroup", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get a User Data Filter", "tags": [ "Data Filters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "patch": { "operationId": "patchEntity@UserDataFilters", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;user.id==321;userGroup.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "users", "userGroups", "facts", "attributes", "labels", "metrics", "datasets", "parameters", "user", "userGroup", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserDataFilterPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserDataFilterPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch a User Data Filter", "tags": [ "Data Filters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "put": { "operationId": "updateEntity@UserDataFilters", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;user.id==321;userGroup.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "user,userGroup,facts,attributes,labels,metrics,datasets,parameters", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "users", "userGroups", "facts", "attributes", "labels", "metrics", "datasets", "parameters", "user", "userGroup", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserDataFilterInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserDataFilterInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiUserDataFilterOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put a User Data Filter", "tags": [ "Data Filters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/visualizationObjects": { "get": { "operationId": "getAllEntities@VisualizationObjects", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "facts", "attributes", "labels", "metrics", "parameters", "datasets", "createdBy", "modifiedBy", "certifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiVisualizationObjectOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiVisualizationObjectOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Visualization Objects", "tags": [ "Visualization Object" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "post": { "operationId": "createEntity@VisualizationObjects", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "facts", "attributes", "labels", "metrics", "parameters", "datasets", "createdBy", "modifiedBy", "certifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiVisualizationObjectPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiVisualizationObjectPostOptionalIdDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Visualization Objects", "tags": [ "Visualization Object" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "ANALYZE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/search": { "post": { "operationId": "searchEntities@VisualizationObjects", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchBody" } } }, "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiVisualizationObjectOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiVisualizationObjectOutList" } } }, "description": "Request successfully processed" } }, "summary": "The search endpoint (beta)", "tags": [ "Visualization Object" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/visualizationObjects/{objectId}": { "delete": { "operationId": "deleteEntity@VisualizationObjects", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete a Visualization Object", "tags": [ "Visualization Object" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "ANALYZE" ] } }, "get": { "operationId": "getEntity@VisualizationObjects", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "facts", "attributes", "labels", "metrics", "parameters", "datasets", "createdBy", "modifiedBy", "certifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get a Visualization Object", "tags": [ "Visualization Object" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "patch": { "operationId": "patchEntity@VisualizationObjects", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "facts", "attributes", "labels", "metrics", "parameters", "datasets", "createdBy", "modifiedBy", "certifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiVisualizationObjectPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiVisualizationObjectPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch a Visualization Object", "tags": [ "Visualization Object" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "ANALYZE" ] } }, "put": { "operationId": "updateEntity@VisualizationObjects", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;createdBy.id==321;modifiedBy.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "createdBy,modifiedBy,certifiedBy,facts,attributes,labels,metrics,parameters,datasets", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "userIdentifiers", "facts", "attributes", "labels", "metrics", "parameters", "datasets", "createdBy", "modifiedBy", "certifiedBy", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiVisualizationObjectInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiVisualizationObjectInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiVisualizationObjectOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put a Visualization Object", "tags": [ "Visualization Object" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "ANALYZE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings": { "get": { "operationId": "getAllEntities@WorkspaceDataFilterSettings", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;workspaceDataFilter.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "workspaceDataFilter", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "workspaceDataFilters", "workspaceDataFilter", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Settings for Workspace Data Filters", "tags": [ "Data Filters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "post": { "operationId": "createEntity@WorkspaceDataFilterSettings", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "workspaceDataFilter", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "workspaceDataFilters", "workspaceDataFilter", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Settings for Workspace Data Filters", "tags": [ "Data Filters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/search": { "post": { "operationId": "searchEntities@WorkspaceDataFilterSettings", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchBody" } } }, "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutList" } } }, "description": "Request successfully processed" } }, "summary": "The search endpoint (beta)", "tags": [ "Data Filters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilterSettings/{objectId}": { "delete": { "operationId": "deleteEntity@WorkspaceDataFilterSettings", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete a Settings for Workspace Data Filter", "tags": [ "Data Filters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", "permissions": [ "MANAGE" ] } }, "get": { "operationId": "getEntity@WorkspaceDataFilterSettings", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;workspaceDataFilter.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "workspaceDataFilter", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "workspaceDataFilters", "workspaceDataFilter", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get a Setting for Workspace Data Filter", "tags": [ "Data Filters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "patch": { "operationId": "patchEntity@WorkspaceDataFilterSettings", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;workspaceDataFilter.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "workspaceDataFilter", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "workspaceDataFilters", "workspaceDataFilter", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch a Settings for Workspace Data Filter", "tags": [ "Data Filters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", "permissions": [ "MANAGE" ] } }, "put": { "operationId": "updateEntity@WorkspaceDataFilterSettings", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString;workspaceDataFilter.id==321", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "workspaceDataFilter", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "workspaceDataFilters", "workspaceDataFilter", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put a Settings for Workspace Data Filter", "tags": [ "Data Filters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage WorkspaceDataFilter/Settings for the workspace the WDF originates and related workspace hierarchy.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters": { "get": { "operationId": "getAllEntities@WorkspaceDataFilters", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "filterSettings", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "workspaceDataFilterSettings", "filterSettings", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Workspace Data Filters", "tags": [ "Data Filters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "post": { "operationId": "createEntity@WorkspaceDataFilters", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "filterSettings", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "workspaceDataFilterSettings", "filterSettings", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Workspace Data Filters", "tags": [ "Data Filters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/search": { "post": { "operationId": "searchEntities@WorkspaceDataFilters", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchBody" } } }, "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutList" } } }, "description": "Request successfully processed" } }, "summary": "The search endpoint (beta)", "tags": [ "Data Filters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/workspaceDataFilters/{objectId}": { "delete": { "operationId": "deleteEntity@WorkspaceDataFilters", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete a Workspace Data Filter", "tags": [ "Data Filters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "get": { "operationId": "getEntity@WorkspaceDataFilters", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "filterSettings", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "workspaceDataFilterSettings", "filterSettings", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get a Workspace Data Filter", "tags": [ "Data Filters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "patch": { "operationId": "patchEntity@WorkspaceDataFilters", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "filterSettings", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "workspaceDataFilterSettings", "filterSettings", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch a Workspace Data Filter", "tags": [ "Data Filters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } }, "put": { "operationId": "updateEntity@WorkspaceDataFilters", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "title==someString;description==someString", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "description": "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).\n\n__WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.", "example": "filterSettings", "explode": false, "in": "query", "name": "include", "required": false, "schema": { "items": { "enum": [ "workspaceDataFilterSettings", "filterSettings", "ALL" ], "type": "string" }, "type": "array" }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put a Workspace Data Filter", "tags": [ "Data Filters" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to manage this object type.", "permissions": [ "MANAGE" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/workspaceSettings": { "get": { "operationId": "getAllEntities@WorkspaceSettings", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "description": "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').", "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/size" }, { "$ref": "#/components/parameters/sort" }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,page,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "page", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutList" } } }, "description": "Request successfully processed" } }, "summary": "Get all Setting for Workspaces", "tags": [ "Workspaces - Settings" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "post": { "operationId": "createEntity@WorkspaceSettings", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceSettingPostOptionalIdDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceSettingPostOptionalIdDocument" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Post Settings for Workspaces", "tags": [ "Workspaces - Settings" ] } }, "/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/search": { "post": { "operationId": "searchEntities@WorkspaceSettings", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "origin", "required": false, "schema": { "default": "ALL", "description": "Defines scope of origin of objects. All by default.", "enum": [ "ALL", "PARENTS", "NATIVE" ], "type": "string" } }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitySearchBody" } } }, "description": "Search request body with filter, pagination, and sorting options", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutList" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutList" } } }, "description": "Request successfully processed" } }, "summary": "The search endpoint (beta)", "tags": [ "Workspaces - Settings" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } } }, "/api/v1/entities/workspaces/{workspaceId}/workspaceSettings/{objectId}": { "delete": { "operationId": "deleteEntity@WorkspaceSettings", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Deleted" } }, "summary": "Delete a Setting for Workspace", "tags": [ "Workspaces - Settings" ] }, "get": { "operationId": "getEntity@WorkspaceSettings", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { "type": "string" } }, { "in": "header", "name": "X-GDC-VALIDATE-RELATIONS", "required": false, "schema": { "default": false, "type": "boolean" } }, { "description": "Include Meta objects.", "example": "metaInclude=origin,all", "explode": false, "in": "query", "name": "metaInclude", "required": false, "schema": { "description": "Included meta objects", "items": { "enum": [ "origin", "all", "ALL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Get a Setting for Workspace", "tags": [ "Workspaces - Settings" ], "x-gdc-security-info": { "description": "Contains minimal permission level required to view this object type.", "permissions": [ "VIEW" ] } }, "patch": { "operationId": "patchEntity@WorkspaceSettings", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceSettingPatchDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceSettingPatchDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Patch a Setting for Workspace", "tags": [ "Workspaces - Settings" ] }, "put": { "operationId": "updateEntity@WorkspaceSettings", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objectId", "required": true, "schema": { "type": "string" } }, { "description": "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').", "example": "content==JsonNodeValue;type==SettingTypeValue", "in": "query", "name": "filter", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceSettingInDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceSettingInDocument" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } }, "application/vnd.gooddata.api+json": { "schema": { "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutDocument" } } }, "description": "Request successfully processed" } }, "summary": "Put a Setting for a Workspace", "tags": [ "Workspaces - Settings" ] } }, "/api/v1/layout/agents": { "get": { "description": "Gets complete layout of AI agent configurations.", "operationId": "getAgentsLayout", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeAgents" } } }, "description": "Retrieved layout of all AI agent configurations." } }, "summary": "Get all AI agent configurations layout", "tags": [ "Organization - Declarative APIs" ], "x-gdc-security-info": { "description": "Permission required to get agents layout.", "permissions": [ "MANAGE" ] } }, "put": { "description": "Sets AI agent configurations in organization.", "operationId": "setAgentsLayout", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeAgents" } } }, "required": true }, "responses": { "204": { "description": "All AI agent configurations set." } }, "summary": "Set all AI agent configurations", "tags": [ "Organization - Declarative APIs" ], "x-gdc-security-info": { "description": "Permission required to set agents layout.", "permissions": [ "MANAGE" ] } } }, "/api/v1/layout/customGeoCollections": { "get": { "description": "Gets complete layout of custom geo collections.", "operationId": "getCustomGeoCollectionsLayout", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeCustomGeoCollections" } } }, "description": "Retrieved layout of all custom geo collections." } }, "summary": "Get all custom geo collections layout", "tags": [ "Organization - Declarative APIs" ], "x-gdc-security-info": { "description": "Permission required to get custom geo collections layout.", "permissions": [ "MANAGE" ] } }, "put": { "description": "Sets custom geo collections in organization.", "operationId": "setCustomGeoCollections", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeCustomGeoCollections" } } }, "required": true }, "responses": { "204": { "description": "All custom geo collections set." } }, "summary": "Set all custom geo collections", "tags": [ "Organization - Declarative APIs" ], "x-gdc-security-info": { "description": "Permission required to set custom geo collections layout.", "permissions": [ "MANAGE" ] } } }, "/api/v1/layout/dataSources": { "get": { "description": "Retrieve all data sources including related physical model.", "operationId": "getDataSourcesLayout", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeDataSources" } } }, "description": "Retrieved all data sources." } }, "summary": "Get all data sources", "tags": [ "Data Source - Declarative APIs" ], "x-gdc-security-info": { "description": "Permission required to get data sources layout.", "permissions": [ "MANAGE" ] } }, "put": { "description": "Set all data sources including related physical model.", "operationId": "putDataSourcesLayout", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeDataSources" } } }, "required": true }, "responses": { "204": { "description": "Defined all data sources." } }, "summary": "Put all data sources", "tags": [ "Data Source - Declarative APIs" ], "x-gdc-security-info": { "description": "Permission required to set data sources layout.", "permissions": [ "MANAGE" ] } } }, "/api/v1/layout/dataSources/{dataSourceId}/permissions": { "get": { "description": "Retrieve current set of permissions of the data source in a declarative form.", "operationId": "getDataSourcePermissions", "parameters": [ { "in": "path", "name": "dataSourceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeDataSourcePermissions" } } }, "description": "Retrieved current set of permissions." } }, "summary": "Get permissions for the data source", "tags": [ "Manage Permissions" ], "x-gdc-security-info": { "description": "Permissions required to manipulate permissions.", "permissions": [ "MANAGE" ] } }, "put": { "description": "set data source permissions.", "operationId": "setDataSourcePermissions", "parameters": [ { "in": "path", "name": "dataSourceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeDataSourcePermissions" } } }, "required": true }, "responses": { "204": { "description": "No Content" } }, "summary": "Set data source permissions.", "tags": [ "Manage Permissions" ], "x-gdc-security-info": { "description": "Permissions to modify the user data filters.", "permissions": [ "MANAGE" ] } } }, "/api/v1/layout/dataSources/{dataSourceId}/statistics": { "delete": { "description": "(BETA) Removes all stored physical statistics for the specified data source.", "operationId": "deleteDataSourceStatistics", "parameters": [ { "in": "path", "name": "dataSourceId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Statistics deleted." } }, "summary": "(BETA) Delete stored physical statistics for a data source", "tags": [ "Other" ], "x-gdc-security-info": { "description": "Permission required to delete data source statistics.", "permissions": [ "MANAGE" ] } }, "get": { "description": "(BETA) Returns previously stored physical table and column statistics. Supports optional filtering by schema and table name.", "operationId": "getDataSourceStatistics", "parameters": [ { "in": "path", "name": "dataSourceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "schemaName", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "tableName", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceStatisticsResponse" } } }, "description": "OK" } }, "summary": "(BETA) Retrieve stored physical statistics for a data source", "tags": [ "Other" ], "x-gdc-security-info": { "description": "Permission required to read data source statistics.", "permissions": [ "USE" ] } }, "put": { "description": "(BETA) Stores or replaces physical statistics (row counts, NDV, null counts, min/max) for tables and columns of a data source.", "operationId": "putDataSourceStatistics", "parameters": [ { "in": "path", "name": "dataSourceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataSourceStatisticsRequest" } } }, "required": true }, "responses": { "204": { "description": "Statistics stored successfully." } }, "summary": "(BETA) Store physical table and column statistics for a data source", "tags": [ "Other" ], "x-gdc-security-info": { "description": "Permission required to store data source statistics.", "permissions": [ "MANAGE" ] } } }, "/api/v1/layout/exportTemplates": { "get": { "description": "Gets complete layout of export templates.", "operationId": "getExportTemplatesLayout", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeExportTemplates" } } }, "description": "Retrieved layout of all export templates." } }, "summary": "Get all export templates layout", "tags": [ "Notification Channels" ], "x-gdc-security-info": { "description": "Permission required to get export templates layout.", "permissions": [ "MANAGE" ] } }, "put": { "description": "Sets export templates in organization.", "operationId": "setExportTemplates", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeExportTemplates" } } }, "required": true }, "responses": { "204": { "description": "All export templates set." } }, "summary": "Set all export templates", "tags": [ "Notification Channels" ], "x-gdc-security-info": { "description": "Permission required to set export templates layout.", "permissions": [ "MANAGE" ] } } }, "/api/v1/layout/identityProviders": { "get": { "description": "Gets complete layout of identity providers.", "operationId": "getIdentityProvidersLayout", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/DeclarativeIdentityProvider" }, "type": "array" } } }, "description": "Retrieved layout of all identity providers." } }, "summary": "Get all identity providers layout", "tags": [ "Identity Providers" ], "x-gdc-security-info": { "description": "Permission required to get identity providers layout.", "permissions": [ "MANAGE" ] } }, "put": { "description": "Sets identity providers in organization.", "operationId": "setIdentityProviders", "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/DeclarativeIdentityProvider" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "All identity providers set." } }, "summary": "Set all identity providers", "tags": [ "Identity Providers" ], "x-gdc-security-info": { "description": "Permission required to set identity providers layout.", "permissions": [ "MANAGE" ] } } }, "/api/v1/layout/notificationChannels": { "get": { "description": "Gets complete layout of notification channels.", "operationId": "getNotificationChannelsLayout", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeNotificationChannels" } } }, "description": "Retrieved layout of all notification channels." } }, "summary": "Get all notification channels layout", "tags": [ "Notification Channels" ], "x-gdc-security-info": { "description": "Permission required to get notification channels layout.", "permissions": [ "MANAGE" ] } }, "put": { "description": "Sets notification channels in organization.", "operationId": "setNotificationChannels", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeNotificationChannels" } } }, "required": true }, "responses": { "204": { "description": "All notification channels set." } }, "summary": "Set all notification channels", "tags": [ "Notification Channels" ], "x-gdc-security-info": { "description": "Permission required to set data filters layout.", "permissions": [ "MANAGE" ] } } }, "/api/v1/layout/organization": { "get": { "description": "Retrieve complete layout of organization, workspaces, user-groups, etc.", "operationId": "getOrganizationLayout", "parameters": [ { "in": "query", "name": "exclude", "required": false, "schema": { "items": { "description": "Defines properties which should not be included in the payload.", "enum": [ "ACTIVITY_INFO" ], "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeOrganization" } } }, "description": "Retrieved all parts of an organization." } }, "summary": "Get organization layout", "tags": [ "Organization - Declarative APIs" ], "x-gdc-security-info": { "description": "Permission required to get organization layout.", "permissions": [ "MANAGE" ] } }, "put": { "description": "Sets complete layout of organization, like workspaces, user-groups, etc.", "operationId": "setOrganizationLayout", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeOrganization" } } }, "required": true }, "responses": { "204": { "description": "Defined all parts of an organization." } }, "summary": "Set organization layout", "tags": [ "Organization - Declarative APIs" ], "x-gdc-security-info": { "description": "Permission required to set organization layout.", "permissions": [ "MANAGE" ] } } }, "/api/v1/layout/organization/permissions": { "get": { "description": "Retrieve organization permissions", "operationId": "getOrganizationPermissions", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/DeclarativeOrganizationPermission" }, "type": "array" } } }, "description": "Retrieved all organization permissions." } }, "summary": "Get organization permissions", "tags": [ "Permissions" ], "x-gdc-security-info": { "description": "Permission required to get organization permissions.", "permissions": [ "MANAGE" ] } }, "put": { "description": "Sets organization permissions", "operationId": "setOrganizationPermissions", "requestBody": { "content": { "application/json": { "schema": { "description": "An array of declarative organization permissions assignments", "items": { "$ref": "#/components/schemas/DeclarativeOrganizationPermission" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "Organization permissions set." } }, "summary": "Set organization permissions", "tags": [ "Permissions" ], "x-gdc-security-info": { "description": "Permission required to set organization permissions.", "permissions": [ "MANAGE" ] } } }, "/api/v1/layout/userGroups": { "get": { "description": "Retrieve all user-groups eventually with parent group.", "operationId": "getUserGroupsLayout", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeUserGroups" } } }, "description": "Retrieved all user groups." } }, "summary": "Get all user groups", "tags": [ "UserGroups - Declarative APIs" ], "x-gdc-security-info": { "description": "Permission required to get groups layout.", "permissions": [ "MANAGE" ] } }, "put": { "description": "Define all user groups with their parents eventually.", "operationId": "putUserGroupsLayout", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeUserGroups" } } }, "required": true }, "responses": { "204": { "description": "Defined all user groups." } }, "summary": "Put all user groups", "tags": [ "UserGroups - Declarative APIs" ], "x-gdc-security-info": { "description": "Permission required to set groups layout.", "permissions": [ "MANAGE" ] } } }, "/api/v1/layout/userGroups/{userGroupId}/permissions": { "get": { "description": "Retrieve current set of permissions of the user-group in a declarative form.", "operationId": "getUserGroupPermissions", "parameters": [ { "in": "path", "name": "userGroupId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeUserGroupPermissions" } } }, "description": "Retrieved current set of permissions." } }, "summary": "Get permissions for the user-group", "tags": [ "Permissions" ], "x-gdc-security-info": { "description": "Permissions required to manipulate permissions.", "permissions": [ "MANAGE" ] } }, "put": { "description": "Set effective permissions for the user-group", "operationId": "setUserGroupPermissions", "parameters": [ { "in": "path", "name": "userGroupId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeUserGroupPermissions" } } }, "required": true }, "responses": { "204": { "description": "User-group permissions successfully set." } }, "summary": "Set permissions for the user-group", "tags": [ "Permissions" ], "x-gdc-security-info": { "description": "Permissions required to manipulate permissions.", "permissions": [ "MANAGE" ] } } }, "/api/v1/layout/users": { "get": { "description": "Retrieve all users including authentication properties.", "operationId": "getUsersLayout", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeUsers" } } }, "description": "Retrieved all users." } }, "summary": "Get all users", "tags": [ "Users - Declarative APIs" ], "x-gdc-security-info": { "description": "Permission required to get users layout.", "permissions": [ "MANAGE" ] } }, "put": { "description": "Set all users and their authentication properties.", "operationId": "putUsersLayout", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeUsers" } } }, "required": true }, "responses": { "204": { "description": "Defined all users." } }, "summary": "Put all users", "tags": [ "Users - Declarative APIs" ], "x-gdc-security-info": { "description": "Permission required to set users layout.", "permissions": [ "MANAGE" ] } } }, "/api/v1/layout/users/{userId}/permissions": { "get": { "description": "Retrieve current set of permissions of the user in a declarative form.", "operationId": "getUserPermissions", "parameters": [ { "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeUserPermissions" } } }, "description": "Retrieved current set of permissions." } }, "summary": "Get permissions for the user", "tags": [ "Permissions" ], "x-gdc-security-info": { "description": "Permissions required to manipulate permissions.", "permissions": [ "MANAGE" ] } }, "put": { "description": "Set effective permissions for the user", "operationId": "setUserPermissions", "parameters": [ { "in": "path", "name": "userId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeUserPermissions" } } }, "required": true }, "responses": { "204": { "description": "User permissions successfully set." } }, "summary": "Set permissions for the user", "tags": [ "Permissions" ], "x-gdc-security-info": { "description": "Permissions required to manipulate permissions.", "permissions": [ "MANAGE" ] } } }, "/api/v1/layout/usersAndUserGroups": { "get": { "description": "Retrieve all users and user groups with theirs properties.", "operationId": "getUsersUserGroupsLayout", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeUsersUserGroups" } } }, "description": "Retrieved all users and user groups." } }, "summary": "Get all users and user groups", "tags": [ "UserGroups - Declarative APIs" ], "x-gdc-security-info": { "description": "Permission required to get user/groups layout.", "permissions": [ "MANAGE" ] } }, "put": { "description": "Define all users and user groups with theirs properties.", "operationId": "putUsersUserGroupsLayout", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeUsersUserGroups" } } }, "required": true }, "responses": { "204": { "description": "Defined all users and user groups." } }, "summary": "Put all users and user groups", "tags": [ "UserGroups - Declarative APIs" ], "x-gdc-security-info": { "description": "Permission required to set user/groups layout.", "permissions": [ "MANAGE" ] } } }, "/api/v1/layout/workspaceDataFilters": { "get": { "description": "Retrieve all workspaces and related workspace data filters (and their settings / values).", "operationId": "getWorkspaceDataFiltersLayout", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeWorkspaceDataFilters" } } }, "description": "Retrieved all workspace data filters." } }, "summary": "Get workspace data filters for all workspaces", "tags": [ "Data Filters" ], "x-gdc-security-info": { "description": "Permission required to get data filters layout.", "permissions": [ "MANAGE" ] } }, "put": { "description": "Sets workspace data filters in all workspaces in entire organization.", "operationId": "setWorkspaceDataFiltersLayout", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeWorkspaceDataFilters" } } }, "required": true }, "responses": { "204": { "description": "All workspace data filters set." } }, "summary": "Set all workspace data filters", "tags": [ "Data Filters" ], "x-gdc-security-info": { "description": "Permission required to set data filters layout.", "permissions": [ "MANAGE" ] } } }, "/api/v1/layout/workspaces": { "get": { "description": "Gets complete layout of workspaces, their hierarchy, models.", "operationId": "getWorkspacesLayout", "parameters": [ { "in": "query", "name": "exclude", "required": false, "schema": { "items": { "description": "Defines properties which should not be included in the payload.", "enum": [ "ACTIVITY_INFO" ], "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeWorkspaces" } } }, "description": "Retrieved layout of all workspaces." } }, "summary": "Get all workspaces layout", "tags": [ "Workspaces - Declarative APIs" ], "x-gdc-security-info": { "description": "Permission required to get workspaces layout.", "permissions": [ "MANAGE" ] } }, "put": { "description": "Sets complete layout of workspaces, their hierarchy, models.", "operationId": "setWorkspacesLayout", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeWorkspaces" } } }, "required": true }, "responses": { "204": { "description": "All workspaces layout set." } }, "summary": "Set all workspaces layout", "tags": [ "Workspaces - Declarative APIs" ], "x-gdc-security-info": { "description": "Permission required to set workspaces layout.", "permissions": [ "MANAGE" ] } } }, "/api/v1/layout/workspaces/{workspaceId}": { "get": { "description": "Retrieve current model of the workspace in declarative form.", "operationId": "getWorkspaceLayout", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "exclude", "required": false, "schema": { "items": { "description": "Defines properties which should not be included in the payload.", "enum": [ "ACTIVITY_INFO" ], "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeWorkspaceModel" } } }, "description": "Retrieved the workspace model." } }, "summary": "Get workspace layout", "tags": [ "Workspaces - Declarative APIs" ], "x-gdc-security-info": { "description": "Permissions required to read the layout.", "permissions": [ "ANALYZE" ] } }, "put": { "description": "Set complete layout of workspace, like model, authorization, etc.", "operationId": "putWorkspaceLayout", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeWorkspaceModel" } } }, "required": true }, "responses": { "204": { "description": "The model of the workspace was set." } }, "summary": "Set workspace layout", "tags": [ "Workspaces - Declarative APIs" ], "x-gdc-security-info": { "description": "Permissions required to modify the layout.", "permissions": [ "MANAGE" ] } } }, "/api/v1/layout/workspaces/{workspaceId}/analyticsModel": { "get": { "description": "Retrieve current analytics model of the workspace.", "operationId": "getAnalyticsModel", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "exclude", "required": false, "schema": { "items": { "description": "Defines properties which should not be included in the payload.", "enum": [ "ACTIVITY_INFO" ], "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeAnalytics" } } }, "description": "Retrieved current analytics model." } }, "summary": "Get analytics model", "tags": [ "Analytics Model" ], "x-gdc-security-info": { "description": "Permissions to read the analytics layout.", "permissions": [ "ANALYZE" ] } }, "put": { "description": "Set effective analytics model of the workspace.", "operationId": "setAnalyticsModel", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeAnalytics" } } }, "required": true }, "responses": { "204": { "description": "Analytics model successfully set." } }, "summary": "Set analytics model", "tags": [ "Analytics Model" ], "x-gdc-security-info": { "description": "Permissions to modify the analytics layout.", "permissions": [ "ANALYZE" ] } } }, "/api/v1/layout/workspaces/{workspaceId}/automations": { "get": { "description": "Retrieve automations for the specific workspace", "operationId": "getAutomations", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "exclude", "required": false, "schema": { "items": { "description": "Defines properties which should not be included in the payload.", "enum": [ "ACTIVITY_INFO" ], "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/DeclarativeAutomation" }, "type": "array" } } }, "description": "Retrieved automations." } }, "summary": "Get automations", "tags": [ "Automations" ], "x-gdc-security-info": { "description": "Permissions to read the automations.", "permissions": [ "MANAGE" ] } }, "put": { "description": "Set automations for the specific workspace.", "operationId": "setAutomations", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/DeclarativeAutomation" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "Automations successfully set." } }, "summary": "Set automations", "tags": [ "Automations" ], "x-gdc-security-info": { "description": "Permissions to modify the automations.", "permissions": [ "MANAGE" ] } } }, "/api/v1/layout/workspaces/{workspaceId}/filterViews": { "get": { "description": "Retrieve filter views for the specific workspace", "operationId": "getFilterViews", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "exclude", "required": false, "schema": { "items": { "description": "Defines properties which should not be included in the payload.", "enum": [ "ACTIVITY_INFO" ], "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/DeclarativeFilterView" }, "type": "array" } } }, "description": "Retrieved filterViews." } }, "summary": "Get filter views", "tags": [ "Filter Views" ], "x-gdc-security-info": { "description": "Permissions to read the filter views.", "permissions": [ "MANAGE" ] } }, "put": { "description": "Set filter views for the specific workspace.", "operationId": "setFilterViews", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/DeclarativeFilterView" }, "type": "array" } } }, "required": true }, "responses": { "204": { "description": "FilterViews successfully set." } }, "summary": "Set filter views", "tags": [ "Filter Views" ], "x-gdc-security-info": { "description": "Permissions to modify the filter views.", "permissions": [ "MANAGE" ] } } }, "/api/v1/layout/workspaces/{workspaceId}/logicalModel": { "get": { "description": "Retrieve current logical model of the workspace in declarative form.", "operationId": "getLogicalModel", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "includeParents", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeModel" } } }, "description": "Retrieved current logical model." } }, "summary": "Get logical model", "tags": [ "LDM - Declarative APIs" ], "x-gdc-security-info": { "description": "Permissions required to read the logical model.", "permissions": [ "ANALYZE" ] } }, "put": { "description": "Set effective logical model of the workspace.", "operationId": "setLogicalModel", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeModel" } } }, "required": true }, "responses": { "204": { "description": "Logical model successfully set." } }, "summary": "Set logical model", "tags": [ "LDM - Declarative APIs" ], "x-gdc-security-info": { "description": "Permissions required to alter the logical model.", "permissions": [ "MANAGE" ] } } }, "/api/v1/layout/workspaces/{workspaceId}/permissions": { "get": { "description": "Retrieve current set of permissions of the workspace in a declarative form.", "operationId": "getWorkspacePermissions", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeWorkspacePermissions" } } }, "description": "Retrieved current set of permissions." } }, "summary": "Get permissions for the workspace", "tags": [ "Permissions" ], "x-gdc-security-info": { "description": "Permissions required to manipulate permissions.", "permissions": [ "MANAGE" ] } }, "put": { "description": "Set effective permissions for the workspace", "operationId": "setWorkspacePermissions", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeWorkspacePermissions" } } }, "required": true }, "responses": { "204": { "description": "Workspace permissions successfully set." } }, "summary": "Set permissions for the workspace", "tags": [ "Permissions" ], "x-gdc-security-info": { "description": "Permissions required to manipulate permissions.", "permissions": [ "MANAGE" ] } } }, "/api/v1/layout/workspaces/{workspaceId}/userDataFilters": { "get": { "description": "Retrieve current user data filters assigned to the workspace.", "operationId": "getUserDataFilters", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeUserDataFilters" } } }, "description": "Retrieved current user data filters." } }, "summary": "Get user data filters", "tags": [ "Other" ], "x-gdc-security-info": { "description": "Permissions to read the user data filters.", "permissions": [ "MANAGE" ] } }, "put": { "description": "Set user data filters assigned to the workspace.", "operationId": "setUserDataFilters", "parameters": [ { "in": "path", "name": "workspaceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeclarativeUserDataFilters" } } }, "required": true }, "responses": { "204": { "description": "User data filters successfully set." } }, "summary": "Set user data filters", "tags": [ "Other" ], "x-gdc-security-info": { "description": "Permissions to modify the user data filters.", "permissions": [ "MANAGE" ] } } }, "/api/v1/location/collections/{collectionId}/items": { "get": { "description": "Retrieve features from a GeoCollections collection as GeoJSON", "operationId": "getCollectionItems", "parameters": [ { "description": "Collection identifier", "example": "countries", "in": "path", "name": "collectionId", "required": true, "schema": { "type": "string" } }, { "description": "Maximum number of features to return", "example": 100, "in": "query", "name": "limit", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Bounding box filter (minx,miny,maxx,maxy)", "example": "-180,-90,180,90", "in": "query", "name": "bbox", "required": false, "schema": { "type": "string" } }, { "description": "List of values to filter features by", "example": "US,CA,MX", "in": "query", "name": "values", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GeoJsonFeatureCollection" } } }, "description": "Features retrieved successfully" }, "404": { "description": "Collection not found" } }, "summary": "Get collection features", "tags": [ "Other" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "VIEW" ] } } }, "/api/v1/location/custom/collections/{collectionId}/items": { "get": { "description": "Retrieve features from a custom (organization-scoped) GeoCollections collection as GeoJSON", "operationId": "getCustomCollectionItems", "parameters": [ { "description": "Collection identifier", "example": "my-custom-collection", "in": "path", "name": "collectionId", "required": true, "schema": { "type": "string" } }, { "description": "Maximum number of features to return", "example": 100, "in": "query", "name": "limit", "required": false, "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": "Bounding box filter (minx,miny,maxx,maxy)", "example": "-180,-90,180,90", "in": "query", "name": "bbox", "required": false, "schema": { "type": "string" } }, { "description": "List of values to filter features by", "example": "US,CA,MX", "in": "query", "name": "values", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/GeoJsonFeatureCollection" } } }, "description": "Features retrieved successfully" }, "404": { "description": "Collection not found" } }, "summary": "Get custom collection features", "tags": [ "Other" ], "x-gdc-security-info": { "description": "Minimal permission required to use this endpoint.", "permissions": [ "VIEW" ] } } }, "/api/v1/options": { "get": { "description": "Retrieves links for all options for different configurations.", "operationId": "getAllOptions", "responses": { "200": { "content": { "application/json": { "examples": { "All options": { "description": "All options", "value": { "options": { "description": "Options resources", "links": { "availableDrivers": "/api/v1/options/availableDrivers" } } } } }, "schema": { "type": "object" } } }, "description": "Links for all configuration options." } }, "summary": "Links for all configuration options", "tags": [ "Options" ] } }, "/api/v1/options/availableDrivers": { "get": { "description": "Retrieves a list of all supported data sources along with information about the used drivers.", "operationId": "getDataSourceDrivers", "responses": { "200": { "content": { "application/json": { "examples": { "All available drivers": { "description": "All available drivers", "value": { "POSTGRESQL": "org.postgresql.Driver", "REDSHIFT": "com.amazon.redshift.jdbc42.Driver" } } }, "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "description": "A list of all available data source drivers." } }, "summary": "Get all available data source drivers", "tags": [ "Available Drivers" ] } }, "/api/v1/profile": { "get": { "description": "Returns a Profile including Organization and Current User Information.", "operationId": "getProfile", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Profile" } } }, "description": "OK" } }, "summary": "Get Profile", "tags": [ "User Authorization" ] } } }, "servers": [ { "description": "GoodData.CN endpoint", "url": "/" } ], "tags": [ { "description": "| APIs for interaction with the AI Lake", "name": "AI Lake" }, { "description": "Use case APIs for user management", "name": "User management" }, { "description": "OGC API Features implementation for GeoCollections collections", "name": "OGC API Features" } ], "x-tagGroups": [ { "name": "Organization", "tags": [ "Cookie Security Configuration", "Organization - Declarative APIs", "Organization - Entity APIs", "Options", "CSP Directives", "JWKS", "Notification Channels", "Identity Providers" ] }, { "name": "Users and User Groups", "tags": [ "API tokens", "Users - Entity APIs", "Users - Declarative APIs", "UserGroups - Entity APIs", "UserGroups - Declarative APIs", "User Authorization", "User Settings", "User Identifiers", "User management" ] }, { "name": "Permissions", "tags": [ "Permissions" ] }, { "name": "Data Source", "tags": [ "Data Source - Declarative APIs", "Data Source - Entity APIs", "Test Connection", "Invalidate Cache", "Manage Permissions", "Available Drivers", "Scanning", "Data source files import", "Data source files analysis", "Data source staging location", "Data source files listing", "Data source files deletion", "Data source files manifest read" ] }, { "name": "Workspaces", "tags": [ "Workspaces - Entity APIs", "Workspaces - Declarative APIs", "Data Filters", "Workspaces - Settings", "Appearance", "Plugins", "Hierarchy", "Translations" ] }, { "name": "Logical Data Model", "tags": [ "Generate Logical Data Model", "LDM - Declarative APIs", "Datasets", "Attributes", "Facts", "Labels" ] }, { "name": "Analytical Objects", "tags": [ "Analytics Model", "Metrics", "Dashboards", "Filter Context", "Filter Views", "Visualization Object", "Parameters", "Dependency Graph", "Attribute Hierarchies" ] }, { "name": "Reporting", "tags": [ "Usage", "Computation", "Smart Functions", "Entitlement", "Reporting - Settings", "Cache usage", "LLM Endpoints" ] }, { "name": "Export & Automations", "tags": [ "Automations", "Tabular export", "Visual export", "Raw export", "Slides export", "Export Definitions", "Image export", "Export templates" ] }, { "name": "AI Lake", "tags": [ "AI Lake - Databases", "AI Lake - Pipe Tables", "AI Lake - Services & Operations" ] }, { "name": "AI Assistant", "tags": [ "AI", "AI Observability" ] }, { "name": "Agents", "tags": [ "Agents" ] }, { "name": "Other", "tags": [ "Other" ] } ] }