From 5e10135bbddf985d41e34dc5c69a4d22853a879e Mon Sep 17 00:00:00 2001 From: adityamittal3107 Date: Thu, 1 Aug 2024 21:48:13 +0530 Subject: [PATCH] Update openapiSpec --- api-spec/openapiSpecv3-2_0.json | 1411 ++++++++++++++++++++++--------- 1 file changed, 993 insertions(+), 418 deletions(-) diff --git a/api-spec/openapiSpecv3-2_0.json b/api-spec/openapiSpecv3-2_0.json index 435815a4..efc4b8ca 100644 --- a/api-spec/openapiSpecv3-2_0.json +++ b/api-spec/openapiSpecv3-2_0.json @@ -37,6 +37,14 @@ ], "description": "Roles for version 9.2.0.cl" }, + { + "name": "10.1.0.cl", + "id": "10.1.0.cl", + "tags": [ + "10.1.0.cl" + ], + "description": "Roles for version 10.1.0.cl" + }, { "name": "10.0.0.cl", "id": "10.0.0.cl", @@ -287,7 +295,10 @@ "CAN_CREATE_OR_EDIT_CONNECTIONS", "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", "CAN_MANAGE_VERSION_CONTROL", - "THIRDPARTY_ANALYSIS" + "THIRDPARTY_ANALYSIS", + "ALLOW_NON_EMBED_FULL_APP_ACCESS", + "CAN_ACCESS_ANALYST_STUDIO", + "CAN_MANAGE_ANALYST_STUDIO" ] } }, @@ -997,7 +1008,10 @@ "CAN_CREATE_OR_EDIT_CONNECTIONS", "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", "CAN_MANAGE_VERSION_CONTROL", - "THIRDPARTY_ANALYSIS" + "THIRDPARTY_ANALYSIS", + "ALLOW_NON_EMBED_FULL_APP_ACCESS", + "CAN_ACCESS_ANALYST_STUDIO", + "CAN_MANAGE_ANALYST_STUDIO" ] } }, @@ -2388,7 +2402,7 @@ "/api/rest/2.0/logs/fetch": { "post": { "operationId": "fetchLogs", - "description": "\n Version: 9.0.0.cl or later\n\nFetches security audit logs. \n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n#### Usage guidelines\n\nBy default, the API retrieves logs for the last 24 hours. You can set a custom duration in EPOCH time. Make sure the log duration specified in your API request doesn’t exceed 24 hours. If you must fetch logs for a longer time range, modify the duration and make multiple sequential API requests.\n\nUpon successful execution, the API returns logs with the following information:\n* timestamp of the event\n* event ID\n* event type\n* name and GUID of the user\n* IP address of ThoughtSpot instance\n\nFor more information about security events returned in the API response, see [Security events](https://developers.thoughtspot.com/docs/logs-api#_security_events).\n\n\n\n\n#### Endpoint URL\n", + "description": "\n Version: 9.0.0.cl or later\n\nFetches security audit logs. \n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n#### Usage guidelines\n\nBy default, the API retrieves logs for the last 24 hours. You can set a custom duration in EPOCH time. Make sure the log duration specified in your API request doesn’t exceed 24 hours. If you must fetch logs for a longer time range, modify the duration and make multiple sequential API requests.\n\nUpon successful execution, the API returns logs with the following information:\n* timestamp of the event\n* event ID\n* event type\n* name and GUID of the user\n* IP address of ThoughtSpot instance\n\nFor more information about security events returned in the API response, see [Security events](https://developers.thoughtspot.com/docs/audit-logs#_security_events).\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Log", "9.0.0.cl" @@ -2940,7 +2954,10 @@ "CAN_MANAGE_VERSION_CONTROL", "THIRDPARTY_ANALYSIS", "CONTROL_TRUSTED_AUTH", - "CAN_CREATE_CATALOG" + "CAN_CREATE_CATALOG", + "ALLOW_NON_EMBED_FULL_APP_ACCESS", + "CAN_ACCESS_ANALYST_STUDIO", + "CAN_MANAGE_ANALYST_STUDIO" ] } }, @@ -3299,8 +3316,7 @@ "format": "int32" }, "org_id": { - "description": "ID of the Org context to log in to. If Org ID is not specified, the user will be logged in to the Org context of their previous login session.", - "default": 0, + "description": "ID of the Org context to log in to. If the Org ID is not specified and secret key is provided then user will be logged into the org corresponding to the secret key, and if secret key is not provided then user will be logged in to the Org context of their previous login session.", "type": "integer", "format": "int32" }, @@ -3434,8 +3450,7 @@ "format": "int32" }, "org_id": { - "description": "ID of the Org context to log in to. If the Org ID is not specified, the user will be logged in to the Org context of their previous login session.", - "default": 0, + "description": "ID of the Org context to log in to. If the Org ID is not specified and secret key is provided then user will be logged into the org corresponding to the secret key, and if secret key is not provided then user will be logged in to the Org context of their previous login session.", "type": "integer", "format": "int32" }, @@ -3886,12 +3901,12 @@ "type": "object" }, "trigger_welcome_email": { - "description": "Flag to indicate whether welcome email should be sent to user", + "description": "Flag to indicate whether welcome email should be sent to user. This parameter is applied only on clusters on which IAM is disabled.", "type": "boolean", "nullable": true }, "trigger_activation_email": { - "description": "Flag to indicate whether activation email should be sent to user", + "description": "Flag to indicate whether activation email should be sent to user.", "type": "boolean", "nullable": true } @@ -5102,7 +5117,7 @@ "/api/rest/2.0/tags/create": { "post": { "operationId": "createTag", - "description": "\n Version: 9.0.0.cl or later\n\nCreates a tag object.\n\nTags are labels that identify a metadata object. For example, you can create a tag to designate subject areas, such as sales, HR, marketing, and finance.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n", + "description": "\n Version: 9.0.0.cl or later\n\nCreates a tag object.\n\nTags are labels that identify a metadata object. For example, you can create a tag to designate subject areas, such as sales, HR, marketing, and finance.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the `TAGMANAGEMENT` (**Can manage tags**) privilege is required to create, edit, and delete tags.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Tags", "9.0.0.cl" @@ -5206,7 +5221,7 @@ "/api/rest/2.0/tags/{tag_identifier}/update": { "post": { "operationId": "updateTag", - "description": "\n Version: 9.0.0.cl or later\n\nUpdates a tag object.\n\nYou can modify the `name` and `color` properties of a tag object. \n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n", + "description": "\n Version: 9.0.0.cl or later\n\nUpdates a tag object.\n\nYou can modify the `name` and `color` properties of a tag object. \n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the `TAGMANAGEMENT` (**Can manage tags**) privilege is required to create, edit, and delete tags.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Tags", "9.0.0.cl" @@ -5292,7 +5307,7 @@ "/api/rest/2.0/tags/{tag_identifier}/delete": { "post": { "operationId": "deleteTag", - "description": "\n Version: 9.0.0.cl or later\n\nDeletes a tag object from the ThoughtSpot system\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.\n\n\n\n\n#### Endpoint URL\n", + "description": "\n Version: 9.0.0.cl or later\n\nDeletes a tag object from the ThoughtSpot system\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the `TAGMANAGEMENT` (**Can manage tags**) privilege is required to create, edit, and delete tags.\n\n\n\n\n#### Endpoint URL\n", "tags": [ "Tags", "9.0.0.cl" @@ -5587,7 +5602,10 @@ "LIVEBOARD_VERIFIER", "PREVIEW_THOUGHTSPOT_SAGE", "CAN_MANAGE_VERSION_CONTROL", - "THIRDPARTY_ANALYSIS" + "THIRDPARTY_ANALYSIS", + "ALLOW_NON_EMBED_FULL_APP_ACCESS", + "CAN_ACCESS_ANALYST_STUDIO", + "CAN_MANAGE_ANALYST_STUDIO" ] } }, @@ -5755,7 +5773,10 @@ "LIVEBOARD_VERIFIER", "PREVIEW_THOUGHTSPOT_SAGE", "CAN_MANAGE_VERSION_CONTROL", - "THIRDPARTY_ANALYSIS" + "THIRDPARTY_ANALYSIS", + "ALLOW_NON_EMBED_FULL_APP_ACCESS", + "CAN_ACCESS_ANALYST_STUDIO", + "CAN_MANAGE_ANALYST_STUDIO" ] } }, @@ -6277,6 +6298,126 @@ } } }, + "/api/rest/2.0/metadata/tml/export/batch": { + "post": { + "operationId": "exportMetadataTMLBatched", + "description": " Version: 10.1.0.cl or later", + "tags": [ + "Metadata", + "10.1.0.cl" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metadata_type": { + "description": "Type of metadata object to export, can be one of USER | ROLE | USER_GROUP", + "type": "string", + "enum": [ + "USER", + "USER_GROUP", + "ROLE" + ] + }, + "batch_offset": { + "description": "Indicates the position within the complete set from where the API should begin returning objects.", + "default": 0, + "type": "integer", + "format": "int32" + }, + "batch_size": { + "description": "Determines the number of objects or items to be retrieved in a single request.", + "default": 20, + "type": "integer", + "format": "int32" + }, + "edoc_format": { + "description": "TML EDOC content format.", + "default": "JSON", + "type": "string", + "enum": [ + "JSON", + "YAML" + ] + }, + "export_dependent": { + "description": "Indicates whether to export dependent metadata objects of specified metadata objects.", + "default": false, + "type": "boolean", + "nullable": true + }, + "all_orgs_override": { + "description": "Indicates whether to export is happening from all orgs context.", + "default": false, + "type": "boolean", + "nullable": true + } + }, + "required": [ + "metadata_type" + ] + } + } + }, + "required": true + }, + "parameters": [], + "responses": { + "200": { + "description": "Export TMLs of specified metadata objects is successful.", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + }, + "400": { + "description": "Invalid request.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "401": { + "description": "Unauthorized access.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "403": { + "description": "Forbidden access.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Unexpected error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, "/api/rest/2.0/metadata/delete": { "post": { "operationId": "deleteMetadata", @@ -6463,7 +6604,7 @@ "type": "object", "properties": { "metadata_type": { - "description": "Type of metadata.\n1. Liveboard\n2. Answers\n3. LOGICAL_TABLE for any data object such as table, worksheet or view.", + "description": "Type of metadata. Required if identifier in metadata_identifies is a name\".\n1. Liveboard\n2. Answers\n3. LOGICAL_TABLE for any data object such as table, worksheet or view.", "type": "string", "enum": [ "LIVEBOARD", @@ -6472,12 +6613,19 @@ ] }, "metadata_identifiers": { - "description": "Unique ID or name of metadata objects. Note: All the identifiers should belong to same metadata_type", + "description": "Unique ID or name of metadata objects. Note: All the names should belong to same metadata_type", "type": "array", "items": { "type": "string" } }, + "metadata": { + "description": "Metadata details for sharing objects.", + "type": "array", + "items": { + "$ref": "#/components/schemas/ShareMetadataTypeInput" + } + }, "permissions": { "description": "Permission details for sharing the objects.", "type": "array", @@ -6486,7 +6634,7 @@ } }, "visualization_identifiers": { - "description": "Options to specify details of Liveboard.", + "description": "Options to specify details of Liveboard. First Liveboard encountered in payload is considered to be the corresponding Liveboard.", "type": "array", "items": { "type": "string" @@ -6523,7 +6671,6 @@ } }, "required": [ - "metadata_identifiers", "permissions", "emails", "message" @@ -7942,7 +8089,10 @@ "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", "CAN_MANAGE_VERSION_CONTROL", "THIRDPARTY_ANALYSIS", - "CAN_CREATE_CATALOG" + "CAN_CREATE_CATALOG", + "ALLOW_NON_EMBED_FULL_APP_ACCESS", + "CAN_ACCESS_ANALYST_STUDIO", + "CAN_MANAGE_ANALYST_STUDIO" ] } } @@ -8065,7 +8215,10 @@ "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", "CAN_MANAGE_VERSION_CONTROL", "THIRDPARTY_ANALYSIS", - "CAN_CREATE_CATALOG" + "CAN_CREATE_CATALOG", + "ALLOW_NON_EMBED_FULL_APP_ACCESS", + "CAN_ACCESS_ANALYST_STUDIO", + "CAN_MANAGE_ANALYST_STUDIO" ] } } @@ -10808,7 +10961,8 @@ "type": "object", "properties": { "error": { - "type": "object" + "type": "object", + "nullable": true } } }, @@ -10892,32 +11046,39 @@ }, "author_id": { "type": "string", - "description": "Unique identifier of author of the user." + "description": "Unique identifier of author of the user.", + "nullable": true }, "can_change_password": { "type": "boolean", - "description": "Defines whether the user can change their password." + "description": "Defines whether the user can change their password.", + "nullable": true }, "complete_detail": { "type": "boolean", - "description": "Defines whether the response has complete detail of the user." + "description": "Defines whether the response has complete detail of the user.", + "nullable": true }, "creation_time_in_millis": { "type": "number", "format": "float", - "description": "Creation time of the user in milliseconds." + "description": "Creation time of the user in milliseconds.", + "nullable": true }, "current_org": { "$ref": "#/components/schemas/Org", - "description": "Current logged-in Org of the user." + "description": "Current logged-in Org of the user.", + "nullable": true }, "deleted": { "type": "boolean", - "description": "Indicates whether the user is deleted." + "description": "Indicates whether the user is deleted.", + "nullable": true }, "deprecated": { "type": "boolean", - "description": "Indicates whether the user is deprecated." + "description": "Indicates whether the user is deprecated.", + "nullable": true }, "account_type": { "type": "string", @@ -10928,7 +11089,8 @@ "OIDC_USER", "REMOTE_USER" ], - "description": "Type of the user account." + "description": "Type of the user account.", + "nullable": true }, "account_status": { "type": "string", @@ -10939,81 +11101,98 @@ "LOCKED", "PENDING" ], - "description": "Status of the user account." + "description": "Status of the user account.", + "nullable": true }, "email": { "type": "string", - "description": "Email of the user." + "description": "Email of the user.", + "nullable": true }, "expiration_time_in_millis": { "type": "number", "format": "float", - "description": "Expiration time of the user in milliseconds." + "description": "Expiration time of the user in milliseconds.", + "nullable": true }, "external": { "type": "boolean", - "description": "Indicates whether the user is external." + "description": "Indicates whether the user is external.", + "nullable": true }, "favorite_metadata": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteMetadataItem" }, - "description": "Metadata objects to add to the users' favorites list." + "description": "Metadata objects to add to the users' favorites list.", + "nullable": true }, "first_login_time_in_millis": { "type": "number", "format": "float", - "description": "Timestamp of the first login session of the user in milliseconds." + "description": "Timestamp of the first login session of the user in milliseconds.", + "nullable": true }, "group_mask": { "type": "integer", "format": "int32", - "description": "Group mask of the user." + "description": "Group mask of the user.", + "nullable": true }, "hidden": { "type": "boolean", - "description": "Indicates whether the user is hidden." + "description": "Indicates whether the user is hidden.", + "nullable": true }, "home_liveboard": { "$ref": "#/components/schemas/Object_ID_And_Name", - "description": "Unique ID or name of the default Liveboard assigned to the user." + "description": "Unique ID or name of the default Liveboard assigned to the user.", + "nullable": true }, "incomplete_details": { "type": "object", - "description": "Incomplete details of user if any present." + "description": "Incomplete details of user if any present.", + "nullable": true }, "is_first_login": { "type": "boolean", - "description": "Indicates whether it is first login of the user." + "description": "Indicates whether it is first login of the user.", + "nullable": true }, "modification_time_in_millis": { "type": "number", "format": "float", - "description": "Last modified time of the user in milliseconds." + "description": "Last modified time of the user in milliseconds.", + "nullable": true }, "modifier_id": { "type": "string", - "description": "Unique identifier of modifier of the user." + "description": "Unique identifier of modifier of the user.", + "nullable": true }, "notify_on_share": { "type": "boolean", - "description": "User preference for receiving email notifications on shared Answers or Liveboard." + "description": "User preference for receiving email notifications on shared Answers or Liveboard.", + "nullable": true }, "onboarding_experience_completed": { "type": "boolean", - "description": "The user preference for turning off the onboarding experience." + "description": "The user preference for turning off the onboarding experience.", + "nullable": true }, "orgs": { "type": "array", "items": { "$ref": "#/components/schemas/Org" }, - "description": "Orgs to which the user belongs." + "description": "Orgs to which the user belongs.", + "nullable": true }, "owner_id": { "type": "string", - "description": "Unique identifier of owner of the user." + "description": "Unique identifier of owner of the user.", + "nullable": true }, "parent_type": { "type": "string", @@ -11021,75 +11200,90 @@ "USER", "GROUP" ], - "description": "Parent type of the user." + "description": "Parent type of the user.", + "nullable": true }, "privileges": { "type": "array", "items": { "type": "string" }, - "description": "Privileges which are assigned to the user." + "description": "Privileges which are assigned to the user.", + "nullable": true }, "show_onboarding_experience": { "type": "boolean", - "description": "User's preference to revisit the new user onboarding experience." + "description": "User's preference to revisit the new user onboarding experience.", + "nullable": true }, "super_user": { "type": "boolean", - "description": "Indicates whether the user is a super user." + "description": "Indicates whether the user is a super user.", + "nullable": true }, "system_user": { "type": "boolean", - "description": "Indicates whether the user is a system user." + "description": "Indicates whether the user is a system user.", + "nullable": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Object_ID_And_Name" }, - "description": "Tags associated with the user." + "description": "Tags associated with the user.", + "nullable": true }, "tenant_id": { "type": "string", - "description": "Unique identifier of tenant of the user." + "description": "Unique identifier of tenant of the user.", + "nullable": true }, "user_groups": { "type": "array", "items": { "$ref": "#/components/schemas/Object_ID_And_Name" }, - "description": "Groups to which the user is assigned." + "description": "Groups to which the user is assigned.", + "nullable": true }, "user_inherited_groups": { "type": "array", "items": { "$ref": "#/components/schemas/Object_ID_And_Name" }, - "description": "Inherited User Groups which the user is part of." + "description": "Inherited User Groups which the user is part of.", + "nullable": true }, "welcome_email_sent": { "type": "boolean", - "description": "Indicates whether welcome email is sent for the user." + "description": "Indicates whether welcome email is sent for the user.", + "nullable": true }, "org_privileges": { "type": "object", - "description": "Privileges which are assigned to the user with org." + "description": "Privileges which are assigned to the user with org.", + "nullable": true }, "preferred_locale": { "type": "string", - "description": "Locale for the user." + "description": "Locale for the user.", + "nullable": true }, "extended_properties": { "type": "object", - "description": "Properties for the user" + "description": "Properties for the user", + "nullable": true }, "extended_preferences": { "type": "object", - "description": "Preferences for the user" + "description": "Preferences for the user", + "nullable": true }, "user_parameters": { "type": "object", - "description": "User Parameters which are specified for the user via JWToken" + "description": "User Parameters which are specified for the user via JWToken", + "nullable": true } } }, @@ -11150,11 +11344,13 @@ "properties": { "id": { "type": "string", - "description": "The unique identifier of the object." + "description": "The unique identifier of the object.", + "nullable": true }, "name": { "type": "string", - "description": "Name of the object." + "description": "Name of the object.", + "nullable": true } }, "description": "The object representation with ID and Name." @@ -11164,7 +11360,8 @@ "properties": { "identifier": { "type": "string", - "description": "Unique ID or name of the metadata object." + "description": "Unique ID or name of the metadata object.", + "nullable": true }, "type": { "type": "string", @@ -11172,7 +11369,8 @@ "LIVEBOARD", "ANSWER" ], - "description": "Type of metadata object." + "description": "Type of metadata object.", + "nullable": true } } }, @@ -11188,7 +11386,8 @@ "CREATED", "MODIFIED" ], - "description": "Name of the field to apply the sort on." + "description": "Name of the field to apply the sort on.", + "nullable": true }, "order": { "type": "string", @@ -11196,7 +11395,8 @@ "ASC", "DESC" ], - "description": "Sort order : ASC(Ascending) or DESC(Descending)." + "description": "Sort order : ASC(Ascending) or DESC(Descending).", + "nullable": true } }, "description": "Sort options." @@ -11206,97 +11406,120 @@ "properties": { "id": { "type": "string", - "description": "The unique identifier of the object" + "description": "The unique identifier of the object", + "nullable": true }, "name": { "type": "string", - "description": "Name of the cluster." + "description": "Name of the cluster.", + "nullable": true }, "release_version": { "type": "string", - "description": "The release version of the cluster." + "description": "The release version of the cluster.", + "nullable": true }, "time_zone": { "type": "string", - "description": "The timezone of the cluster." + "description": "The timezone of the cluster.", + "nullable": true }, "locale": { "type": "string", - "description": "The default locale of the cluster." + "description": "The default locale of the cluster.", + "nullable": true }, "date_format": { "type": "string", - "description": "The default date format representation of the cluster." + "description": "The default date format representation of the cluster.", + "nullable": true }, "api_version": { "type": "string", - "description": "The API version of the cluster." + "description": "The API version of the cluster.", + "nullable": true }, "type": { "type": "string", - "description": "The deployment type of the cluster." + "description": "The deployment type of the cluster.", + "nullable": true }, "environment": { "type": "string", - "description": "The deployed environment of the cluster." + "description": "The deployed environment of the cluster.", + "nullable": true }, "license": { "type": "string", - "description": "The license applied to the cluster." + "description": "The license applied to the cluster.", + "nullable": true }, "date_time_format": { "type": "string", - "description": "The default date time format representation of the cluster." + "description": "The default date time format representation of the cluster.", + "nullable": true }, "time_format": { "type": "string", - "description": "The default time format representation of the cluster." + "description": "The default time format representation of the cluster.", + "nullable": true }, "system_user_id": { "type": "string", - "description": "The unique identifier of system user." + "description": "The unique identifier of system user.", + "nullable": true }, "super_user_id": { "type": "string", - "description": "The unique identifier of super user." + "description": "The unique identifier of super user.", + "nullable": true }, "hidden_object_id": { "type": "string", - "description": "The unique identifier of hidden object." + "description": "The unique identifier of hidden object.", + "nullable": true }, "system_group_id": { "type": "string", - "description": "The unique identifier of system group." + "description": "The unique identifier of system group.", + "nullable": true }, "tsadmin_user_id": { "type": "string", - "description": "The unique identifier of tsadmin user." + "description": "The unique identifier of tsadmin user.", + "nullable": true }, "admin_group_id": { "type": "string", - "description": "The unique identifier of admin group." + "description": "The unique identifier of admin group.", + "nullable": true }, "all_tables_connection_id": { "type": "string", - "description": "The unique identifier of all tables connection." + "description": "The unique identifier of all tables connection.", + "nullable": true }, "all_user_group_id": { "type": "string", - "description": "The unique identifier of ALL group." + "description": "The unique identifier of ALL group.", + "nullable": true }, "accept_language": { "type": "string", - "description": "The supported accept language by the cluster." + "description": "The supported accept language by the cluster.", + "nullable": true }, "all_user_group_member_user_count": { "type": "integer", "format": "int32", - "description": "The count of users of ALL group." + "description": "The count of users of ALL group.", + "nullable": true }, "logical_model_version": { "type": "integer", "format": "int32", - "description": "The version number of logical model of the cluster." + "description": "The version number of logical model of the cluster.", + "nullable": true } } }, @@ -11304,7 +11527,8 @@ "type": "object", "properties": { "onboarding_content_url": { - "type": "string" + "type": "string", + "nullable": true } } }, @@ -11314,11 +11538,13 @@ "id": { "type": "integer", "format": "int32", - "description": "Unique identifier of the Org." + "description": "Unique identifier of the Org.", + "nullable": true }, "name": { "type": "string", - "description": "Name of the Org." + "description": "Name of the Org.", + "nullable": true }, "status": { "type": "string", @@ -11326,11 +11552,13 @@ "ACTIVE", "IN_ACTIVE" ], - "description": "Status of the Org." + "description": "Status of the Org.", + "nullable": true }, "description": { "type": "string", - "description": "Description of the Org." + "description": "Description of the Org.", + "nullable": true }, "visibility": { "type": "string", @@ -11338,7 +11566,8 @@ "SHOW", "HIDDEN" ], - "description": "Visibility of the Org." + "description": "Visibility of the Org.", + "nullable": true } } }, @@ -11356,36 +11585,46 @@ "type": "string" }, "color": { - "type": "string" + "type": "string", + "nullable": true }, "deleted": { - "type": "boolean" + "type": "boolean", + "nullable": true }, "hidden": { - "type": "boolean" + "type": "boolean", + "nullable": true }, "external": { - "type": "boolean" + "type": "boolean", + "nullable": true }, "deprecated": { - "type": "boolean" + "type": "boolean", + "nullable": true }, "creation_time_in_millis": { "type": "number", - "format": "float" + "format": "float", + "nullable": true }, "modification_time_in_millis": { "type": "number", - "format": "float" + "format": "float", + "nullable": true }, "author_id": { - "type": "string" + "type": "string", + "nullable": true }, "modifier_id": { - "type": "string" + "type": "string", + "nullable": true }, "owner_id": { - "type": "string" + "type": "string", + "nullable": true } } }, @@ -11400,39 +11639,47 @@ "properties": { "author_id": { "type": "string", - "description": "The unique identifier of the object" + "description": "The unique identifier of the object", + "nullable": true }, "complete_detail": { "type": "boolean", - "description": "Indicates whether the response has complete detail of the group." + "description": "Indicates whether the response has complete detail of the group.", + "nullable": true }, "content": { "type": "object", - "description": "Content details of the group" + "description": "Content details of the group", + "nullable": true }, "creation_time_in_millis": { "type": "number", "format": "float", - "description": "Creation time of the group in milliseconds" + "description": "Creation time of the group in milliseconds", + "nullable": true }, "default_liveboards": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" }, - "description": "Liveboards that are assigned as default Liveboards to the group." + "description": "Liveboards that are assigned as default Liveboards to the group.", + "nullable": true }, "deleted": { "type": "boolean", - "description": "Indicates whether the group is deleted" + "description": "Indicates whether the group is deleted", + "nullable": true }, "deprecated": { "type": "boolean", - "description": "Indicates whether the group is deprecated" + "description": "Indicates whether the group is deprecated", + "nullable": true }, "description": { "type": "string", - "description": "Description of the group" + "description": "Description of the group", + "nullable": true }, "display_name": { "type": "string", @@ -11440,16 +11687,19 @@ }, "external": { "type": "boolean", - "description": "Indicates whether the group is external" + "description": "Indicates whether the group is external", + "nullable": true }, "generation_number": { "type": "integer", "format": "int32", - "description": "Generation number of the group" + "description": "Generation number of the group", + "nullable": true }, "hidden": { "type": "boolean", - "description": "Indicates whether the group is hidden" + "description": "Indicates whether the group is hidden", + "nullable": true }, "id": { "type": "string", @@ -11458,26 +11708,31 @@ "index": { "type": "integer", "format": "int32", - "description": "Index number of the group" + "description": "Index number of the group", + "nullable": true }, "index_version": { "type": "integer", "format": "int32", - "description": "Index version number of the group" + "description": "Index version number of the group", + "nullable": true }, "metadata_version": { "type": "integer", "format": "int32", - "description": "Metadata version number of the group" + "description": "Metadata version number of the group", + "nullable": true }, "modification_time_in_millis": { "type": "number", "format": "float", - "description": "Last modified time of the group in milliseconds." + "description": "Last modified time of the group in milliseconds.", + "nullable": true }, "modifier_id": { "type": "string", - "description": "The unique identifier of the object" + "description": "The unique identifier of the object", + "nullable": true }, "name": { "type": "string", @@ -11488,11 +11743,13 @@ "items": { "$ref": "#/components/schemas/UserGroup" }, - "description": "Orgs in which group exists." + "description": "Orgs in which group exists.", + "nullable": true }, "owner_id": { "type": "string", - "description": "The unique identifier of the object" + "description": "The unique identifier of the object", + "nullable": true }, "parent_type": { "type": "string", @@ -11500,32 +11757,37 @@ "USER", "GROUP" ], - "description": "Parent type of the group." + "description": "Parent type of the group.", + "nullable": true }, "privileges": { "type": "array", "items": { "type": "string" }, - "description": "Privileges which are assigned to the group" + "description": "Privileges which are assigned to the group", + "nullable": true }, "sub_groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" }, - "description": "Groups who are part of the group" + "description": "Groups who are part of the group", + "nullable": true }, "system_group": { "type": "boolean", - "description": "Indicates whether the group is a system group." + "description": "Indicates whether the group is a system group.", + "nullable": true }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" }, - "description": "Tags associated with the group." + "description": "Tags associated with the group.", + "nullable": true }, "type": { "type": "string", @@ -11533,14 +11795,16 @@ "LOCAL_GROUP", "LDAP_GROUP" ], - "description": "Type of the group." + "description": "Type of the group.", + "nullable": true }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" }, - "description": "Users who are part of the group." + "description": "Users who are part of the group.", + "nullable": true }, "visibility": { "type": "string", @@ -11555,7 +11819,8 @@ "items": { "$ref": "#/components/schemas/Role" }, - "description": "List of roles assgined to the user" + "description": "List of roles assgined to the user", + "nullable": true } } }, @@ -11564,11 +11829,13 @@ "properties": { "id": { "type": "string", - "description": "id of the role" + "description": "id of the role", + "nullable": true }, "name": { "type": "string", - "description": "name of the role" + "description": "name of the role", + "nullable": true } } }, @@ -11577,11 +11844,13 @@ "properties": { "identifier": { "type": "string", - "description": "Unique ID or name of the metadata." + "description": "Unique ID or name of the metadata.", + "nullable": true }, "name_pattern": { "type": "string", - "description": "A pattern to match the case-insensitive name of the metadata object. User % for a wildcard match." + "description": "A pattern to match the case-insensitive name of the metadata object. User % for a wildcard match.", + "nullable": true }, "type": { "type": "string", @@ -11594,9 +11863,11 @@ "TAG", "USER", "USER_GROUP", - "LOGICAL_RELATIONSHIP" + "LOGICAL_RELATIONSHIP", + "INSIGHT_SPEC" ], - "description": "Type of metadata. Required if the name of the object is set as identifier. This attribute is optional when the object GUID is specified as identifier.\n1. Liveboard\n2. Answers\n3. LOGICAL_TABLE for any data object such as table, worksheet or view.\n4. LOGICAL_COLUMN for a column of any data object such as table, worksheet or view.\n5. CONNECTION for creating or modify data connections.\n6. TAG for tag objects.\n7. USER for user objects.\n8. USER_GROUP for group objects.\n9. LOGICAL_RELATIONSHIP for table or worksheet joins. A join combines from one or several data object by using matching values" + "description": "Type of metadata. Required if the name of the object is set as identifier. This attribute is optional when the object GUID is specified as identifier.\n1. Liveboard\n2. Answers\n3. LOGICAL_TABLE for any data object such as table, worksheet or view.\n4. LOGICAL_COLUMN for a column of any data object such as table, worksheet or view.\n5. CONNECTION for creating or modify data connections.\n6. TAG for tag objects.\n7. USER for user objects.\n8. USER_GROUP for group objects.\n9. LOGICAL_RELATIONSHIP for table or worksheet joins. A join combines from one or several data object by using matching values\n10. INSIGHT_SPEC for SpotIQ objects", + "nullable": true } } }, @@ -11645,9 +11916,10 @@ "TAG", "USER", "USER_GROUP", - "LOGICAL_RELATIONSHIP" + "LOGICAL_RELATIONSHIP", + "INSIGHT_SPEC" ], - "description": "Type of metadata. Required if the name of the object is set as identifier. This attribute is optional when the object GUID is specified as identifier.\n1. Liveboard\n2. Answers\n3. LOGICAL_TABLE for any data object such as table, worksheet or view\n4. LOGICAL_COLUMN for a column of any data object such as table, worksheet or view\n5. CONNECTION for connection objects\n6. TAG for tag objects\n7. USER for user objects\n8. USER_GROUP for group objects\n9. LOGICAL_RELATIONSHIP for table or worksheet joins. A join combines from one or several data object by using matching values." + "description": "Type of metadata. Required if the name of the object is set as identifier. This attribute is optional when the object GUID is specified as identifier.\n1. Liveboard\n2. Answers\n3. LOGICAL_TABLE for any data object such as table, worksheet or view\n4. LOGICAL_COLUMN for a column of any data object such as table, worksheet or view\n5. CONNECTION for connection objects\n6. TAG for tag objects\n7. USER for user objects\n8. USER_GROUP for group objects\n9. LOGICAL_RELATIONSHIP for table or worksheet joins. A join combines from one or several data object by using matching values.\n10. INSIGHT_SPEC for SpotIQ objects" } } }, @@ -11657,14 +11929,16 @@ "include": { "type": "boolean", "default": false, - "description": "Includes objects marked as favorite for the specified users." + "description": "Includes objects marked as favorite for the specified users.", + "nullable": true }, "user_identifiers": { "type": "array", "items": { "type": "string" }, - "description": "Unique ID or name of the users. If not specified, the favorite objects of current logged in user are returned." + "description": "Unique ID or name of the users. If not specified, the favorite objects of current logged in user are returned.", + "nullable": true } }, "description": "Favorite object options." @@ -11684,7 +11958,8 @@ "FAVORITES", "LAST_ACCESSED" ], - "description": "Name of the field to apply the sort on." + "description": "Name of the field to apply the sort on.", + "nullable": true }, "order": { "type": "string", @@ -11692,7 +11967,8 @@ "ASC", "DESC" ], - "description": "Sort order : ASC(Ascending) or DESC(Descending)." + "description": "Sort order : ASC(Ascending) or DESC(Descending).", + "nullable": true } }, "description": "Sort options." @@ -11705,11 +11981,13 @@ "properties": { "metadata_id": { "type": "string", - "description": "Unique identifier of the metadata." + "description": "Unique identifier of the metadata.", + "nullable": true }, "metadata_name": { "type": "string", - "description": "Name of the metadata." + "description": "Name of the metadata.", + "nullable": true }, "metadata_type": { "type": "string", @@ -11728,33 +12006,39 @@ }, "dependent_objects": { "type": "object", - "description": "Details of dependent objects of the metadata objects." + "description": "Details of dependent objects of the metadata objects.", + "nullable": true }, "incomplete_objects": { "type": "array", "items": { "type": "object" }, - "description": "Details of incomplete information of the metadata objects if any." + "description": "Details of incomplete information of the metadata objects if any.", + "nullable": true }, "metadata_detail": { "type": "object", - "description": "Complete details of the metadata objects." + "description": "Complete details of the metadata objects.", + "nullable": true }, "metadata_header": { "type": "object", - "description": "Header information of the metadata objects." + "description": "Header information of the metadata objects.", + "nullable": true }, "visualization_headers": { "type": "array", "items": { "type": "object" }, - "description": "Visualization header information of the metadata objects." + "description": "Visualization header information of the metadata objects.", + "nullable": true }, "stats": { "type": "object", - "description": "Stats of the metadata object. Includes views, favorites, last_accessed." + "description": "Stats of the metadata object. Includes views, favorites, last_accessed.", + "nullable": true } }, "description": "Metadata Search Response Object." @@ -11829,22 +12113,26 @@ "include_cover_page": { "type": "boolean", "default": true, - "description": "Indicates whether to include the cover page with the Liveboard title." + "description": "Indicates whether to include the cover page with the Liveboard title.", + "nullable": true }, "include_custom_logo": { "type": "boolean", "default": true, - "description": "Indicates whether to include customized wide logo in the footer if available." + "description": "Indicates whether to include customized wide logo in the footer if available.", + "nullable": true }, "include_filter_page": { "type": "boolean", "default": true, - "description": "Indicates whether to include a page with all applied filters." + "description": "Indicates whether to include a page with all applied filters.", + "nullable": true }, "include_page_number": { "type": "boolean", "default": true, - "description": "Indicates whether to include page number in the footer of each page." + "description": "Indicates whether to include page number in the footer of each page.", + "nullable": true }, "page_orientation": { "type": "string", @@ -11853,16 +12141,19 @@ "LANDSCAPE" ], "default": "PORTRAIT", - "description": "Page orientation of the PDF." + "description": "Page orientation of the PDF.", + "nullable": true }, "truncate_table": { "type": "boolean", "default": false, - "description": "Indicates whether to include only the first page of the tables." + "description": "Indicates whether to include only the first page of the tables.", + "nullable": true }, "page_footer_text": { "type": "string", - "description": "Text to include in the footer of each page." + "description": "Text to include in the footer of each page.", + "nullable": true } } }, @@ -11872,12 +12163,14 @@ "include_cover_page": { "type": "boolean", "default": false, - "description": "Indicates whether to include the cover page with the Liveboard title." + "description": "Indicates whether to include the cover page with the Liveboard title.", + "nullable": true }, "include_filter_page": { "type": "boolean", "default": false, - "description": "Indicates whether to include a page with all applied filters." + "description": "Indicates whether to include a page with all applied filters.", + "nullable": true } } }, @@ -11885,7 +12178,8 @@ "type": "object", "properties": { "principal_permission_details": { - "type": "object" + "type": "object", + "nullable": true } } }, @@ -11893,7 +12187,8 @@ "type": "object", "properties": { "metadata_permission_details": { - "type": "object" + "type": "object", + "nullable": true } } }, @@ -11913,7 +12208,8 @@ "USER", "USER_GROUP" ], - "description": "Principal type." + "description": "Principal type.", + "nullable": true } } }, @@ -11932,7 +12228,8 @@ "LOGICAL_COLUMN", "CONNECTION" ], - "description": "Type of metadata object." + "description": "Type of metadata object.", + "nullable": true }, "identifier": { "type": "string", @@ -12088,11 +12385,13 @@ }, "visualization_id": { "type": "string", - "description": "Unique ID of the visualization." + "description": "Unique ID of the visualization.", + "nullable": true }, "visualization_name": { "type": "string", - "description": "Name of the visualization." + "description": "Name of the visualization.", + "nullable": true } } }, @@ -12144,34 +12443,41 @@ "properties": { "repository_url": { "type": "string", - "description": "Remote repository URL configured" + "description": "Remote repository URL configured", + "nullable": true }, "username": { "type": "string", - "description": "Username to authenticate connection to the version control system" + "description": "Username to authenticate connection to the version control system", + "nullable": true }, "commit_branch_name": { "type": "string", - "description": "Name of the remote branch where objects from this Thoughtspot instance will be versioned." + "description": "Name of the remote branch where objects from this Thoughtspot instance will be versioned.", + "nullable": true }, "branches": { "type": "array", "items": { "type": "string" }, - "description": "Branches that have been pulled in local repository" + "description": "Branches that have been pulled in local repository", + "nullable": true }, "enable_guid_mapping": { "type": "boolean", - "description": "Maintain mapping of guid for the deployment to an instance" + "description": "Maintain mapping of guid for the deployment to an instance", + "nullable": true }, "configuration_branch_name": { "type": "string", - "description": "Name of the branch where the configuration files related to operations between Thoughtspot and version control repo should be maintained." + "description": "Name of the branch where the configuration files related to operations between Thoughtspot and version control repo should be maintained.", + "nullable": true }, "org": { "$ref": "#/components/schemas/Org", - "description": "Details of the Org" + "description": "Details of the Org", + "nullable": true } } }, @@ -12217,11 +12523,13 @@ "properties": { "email": { "type": "string", - "description": "Email id of the committer" + "description": "Email id of the committer", + "nullable": true }, "username": { "type": "string", - "description": "Username of the committer" + "description": "Username of the committer", + "nullable": true } } }, @@ -12230,11 +12538,13 @@ "properties": { "email": { "type": "string", - "description": "Email id of the committer" + "description": "Email id of the committer", + "nullable": true }, "username": { "type": "string", - "description": "Username of the committer" + "description": "Username of the committer", + "nullable": true } } }, @@ -12243,18 +12553,21 @@ "properties": { "identifier": { "type": "string", - "description": "Unique ID or name of the connection." + "description": "Unique ID or name of the connection.", + "nullable": true }, "name_pattern": { "type": "string", - "description": "A pattern to match case-insensitive name of the connection object. User `%` for a wildcard match." + "description": "A pattern to match case-insensitive name of the connection object. User `%` for a wildcard match.", + "nullable": true }, "data_warehouse_objects": { "type": "array", "items": { "$ref": "#/components/schemas/DataWarehouseObjectInput" }, - "description": "Filter options for databases, schemas, tables and columns." + "description": "Filter options for databases, schemas, tables and columns.", + "nullable": true } } }, @@ -12263,19 +12576,23 @@ "properties": { "database": { "type": "string", - "description": "Name of the database." + "description": "Name of the database.", + "nullable": true }, "schema": { "type": "string", - "description": "Name of the schema within the database." + "description": "Name of the schema within the database.", + "nullable": true }, "table": { "type": "string", - "description": "Name of the table within the schema." + "description": "Name of the table within the schema.", + "nullable": true }, "column": { "type": "string", - "description": "Name of the column within the table." + "description": "Name of the column within the table.", + "nullable": true } } }, @@ -12296,7 +12613,8 @@ "USER_STATE", "ROW_COUNT" ], - "description": "Name of the field to apply the sort on." + "description": "Name of the field to apply the sort on.", + "nullable": true }, "order": { "type": "string", @@ -12304,7 +12622,8 @@ "ASC", "DESC" ], - "description": "Sort order : ASC(Ascending) or DESC(Descending)." + "description": "Sort order : ASC(Ascending) or DESC(Descending).", + "nullable": true } } }, @@ -12326,7 +12645,8 @@ }, "description": { "type": "string", - "description": "Description of the connection." + "description": "Description of the connection.", + "nullable": true }, "data_warehouse_type": { "type": "string", @@ -12366,11 +12686,13 @@ }, "data_warehouse_objects": { "$ref": "#/components/schemas/DataWarehouseObjects", - "description": "List of Data warehouse objects" + "description": "List of Data warehouse objects", + "nullable": true }, "details": { "type": "object", - "description": "Details of the connection." + "description": "Details of the connection.", + "nullable": true } } }, @@ -12404,11 +12726,13 @@ "items": { "$ref": "#/components/schemas/SchemaObject" }, - "description": "Schemas of the database." + "description": "Schemas of the database.", + "nullable": true }, "auto_created": { "type": "boolean", - "description": "Determines if the object is auto created." + "description": "Determines if the object is auto created.", + "nullable": true } } }, @@ -12427,7 +12751,8 @@ "items": { "$ref": "#/components/schemas/Table" }, - "description": "Tables in the schema." + "description": "Tables in the schema.", + "nullable": true } } }, @@ -12446,30 +12771,36 @@ "items": { "$ref": "#/components/schemas/Column" }, - "description": "Columns of the table." + "description": "Columns of the table.", + "nullable": true }, "type": { "type": "string", - "description": "Type of table. Either view or table" + "description": "Type of table. Either view or table", + "nullable": true }, "description": { "type": "string", - "description": "Description of the table" + "description": "Description of the table", + "nullable": true }, "selected": { "type": "boolean", - "description": "Determines if the table is selected" + "description": "Determines if the table is selected", + "nullable": true }, "linked": { "type": "boolean", - "description": "Determines if the table is linked" + "description": "Determines if the table is linked", + "nullable": true }, "relationships": { "type": "array", "items": { "type": "object" }, - "description": "List of relationships for the table" + "description": "List of relationships for the table", + "nullable": true } } }, @@ -12490,19 +12821,23 @@ }, "is_aggregate": { "type": "string", - "description": "Determines if the column schema is an aggregate" + "description": "Determines if the column schema is an aggregate", + "nullable": true }, "can_import": { "type": "boolean", - "description": "Determines if the column schema can be imported" + "description": "Determines if the column schema can be imported", + "nullable": true }, "selected": { "type": "boolean", - "description": "Determines if the table is selected" + "description": "Determines if the table is selected", + "nullable": true }, "is_linked_active": { "type": "boolean", - "description": "Determines if the table is linked" + "description": "Determines if the table is linked", + "nullable": true } } }, @@ -12530,21 +12865,24 @@ "groups_assigned_count": { "type": "integer", "format": "int32", - "description": "number of groups assigned with this role" + "description": "number of groups assigned with this role", + "nullable": true }, "orgs": { "type": "array", "items": { "$ref": "#/components/schemas/GenericInfo" }, - "description": "Orgs in which role exists." + "description": "Orgs in which role exists.", + "nullable": true }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/GenericInfo" }, - "description": "Details of groups assigned with this role" + "description": "Details of groups assigned with this role", + "nullable": true }, "privileges": { "type": "array", @@ -12590,7 +12928,10 @@ "CAN_MANAGE_VERSION_CONTROL", "THIRDPARTY_ANALYSIS", "CONTROL_TRUSTED_AUTH", - "CAN_CREATE_CATALOG" + "CAN_CREATE_CATALOG", + "ALLOW_NON_EMBED_FULL_APP_ACCESS", + "CAN_ACCESS_ANALYST_STUDIO", + "CAN_MANAGE_ANALYST_STUDIO" ] }, "description": "Privileges granted to the role." @@ -12602,43 +12943,53 @@ "MODIFY", "NO_ACCESS" ], - "description": "Permission details of the Role" + "description": "Permission details of the Role", + "nullable": true }, "author_id": { "type": "string", - "description": "Unique identifier of author of the role." + "description": "Unique identifier of author of the role.", + "nullable": true }, "modifier_id": { "type": "string", - "description": "Unique identifier of modifier of the role." + "description": "Unique identifier of modifier of the role.", + "nullable": true }, "creation_time_in_millis": { "type": "object", - "description": "Creation time of the role in milliseconds." + "description": "Creation time of the role in milliseconds.", + "nullable": true }, "modification_time_in_millis": { "type": "object", - "description": "Last modified time of the role in milliseconds." + "description": "Last modified time of the role in milliseconds.", + "nullable": true }, "deleted": { "type": "boolean", - "description": "Indicates whether the role is deleted." + "description": "Indicates whether the role is deleted.", + "nullable": true }, "deprecated": { "type": "boolean", - "description": "Indicates whether the role is deprecated." + "description": "Indicates whether the role is deprecated.", + "nullable": true }, "external": { "type": "boolean", - "description": "Indicates whether the role is external." + "description": "Indicates whether the role is external.", + "nullable": true }, "hidden": { "type": "boolean", - "description": "Indicates whether the role is hidden." + "description": "Indicates whether the role is hidden.", + "nullable": true }, "shared_via_connection": { "type": "boolean", - "description": "Indicates whether the role is shared via connection" + "description": "Indicates whether the role is shared via connection", + "nullable": true } }, "description": "Response for search role api should handle hidden privileges as well." @@ -12648,7 +12999,8 @@ "properties": { "visibility": { "type": "boolean", - "description": "Custom action is available on all visualizations. Earlier naming convention: LOCAL/GLOBAL. TRUE signifies GLOBAL for backward compatibility." + "description": "Custom action is available on all visualizations. Earlier naming convention: LOCAL/GLOBAL. TRUE signifies GLOBAL for backward compatibility.", + "nullable": true } }, "description": "Default Custom action configuration. This includes the custom action's visibility across all visualizations and Answers. By default, a custom action is added to all visualizations and Answers." @@ -12679,7 +13031,8 @@ "items": { "$ref": "#/components/schemas/Metadata_Association_Item" }, - "description": "Metadata objects to assign the the custom action to." + "description": "Metadata objects to assign the the custom action to.", + "nullable": true }, "name": { "type": "string", @@ -12690,7 +13043,8 @@ "items": { "$ref": "#/components/schemas/Object_ID_And_Name" }, - "description": "Unique ID or name of the User groups which are associated with the custom action." + "description": "Unique ID or name of the User groups which are associated with the custom action.", + "nullable": true } }, "description": "Custom action details" @@ -12700,11 +13054,13 @@ "properties": { "CALLBACK": { "$ref": "#/components/schemas/CALLBACK", - "description": "CALLBACK Custom Action Type" + "description": "CALLBACK Custom Action Type", + "nullable": true }, "URL": { "$ref": "#/components/schemas/URL", - "description": "URL Custom Action Type" + "description": "URL Custom Action Type", + "nullable": true } }, "description": "Type and Configuration for Custom Actions" @@ -12714,7 +13070,8 @@ "properties": { "reference": { "type": "string", - "description": "Reference name of the SDK. By default, the value will be set to action name." + "description": "Reference name of the SDK. By default, the value will be set to action name.", + "nullable": true } }, "description": "CALLBACK Custom Action Type" @@ -12727,14 +13084,16 @@ "properties": { "authentication": { "$ref": "#/components/schemas/Authentication", - "description": "Authorization type for the custom action." + "description": "Authorization type for the custom action.", + "nullable": true }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/ParametersListItem" }, - "description": "Query parameters for url." + "description": "Query parameters for url.", + "nullable": true }, "url": { "type": "string", @@ -12742,7 +13101,8 @@ }, "reference": { "type": "string", - "description": "Reference name of the SDK. By default, the value will be set to action name." + "description": "Reference name of the SDK. By default, the value will be set to action name.", + "nullable": true } }, "description": "URL Custom Action Type" @@ -12752,19 +13112,23 @@ "properties": { "API_Key": { "$ref": "#/components/schemas/API_Key", - "description": "With API key auth, you send a key-value pair to the API either in the request headers or query parameters." + "description": "With API key auth, you send a key-value pair to the API either in the request headers or query parameters.", + "nullable": true }, "Basic_Auth": { "$ref": "#/components/schemas/Basic_Auth", - "description": "Basic Auth: Basic authentication involves sending a verified username and password with your request." + "description": "Basic Auth: Basic authentication involves sending a verified username and password with your request.", + "nullable": true }, "Bearer_Token": { "type": "string", - "description": "Bearer tokens enable requests to authenticate using an access key." + "description": "Bearer tokens enable requests to authenticate using an access key.", + "nullable": true }, "No_Auth": { "type": "string", - "description": "No authorization. If your request doesn't require authorization." + "description": "No authorization. If your request doesn't require authorization.", + "nullable": true } }, "description": "Authorization type for the custom action." @@ -12774,11 +13138,13 @@ "properties": { "key": { "type": "string", - "description": "Enter your key name" + "description": "Enter your key name", + "nullable": true }, "value": { "type": "string", - "description": "Enter you key value" + "description": "Enter you key value", + "nullable": true } }, "description": "With API key auth, you send a key-value pair to the API either in the request headers or query parameters." @@ -12788,11 +13154,13 @@ "properties": { "password": { "type": "string", - "description": "Password for the basic authentication" + "description": "Password for the basic authentication", + "nullable": true }, "username": { "type": "string", - "description": "Username for the basic authentication" + "description": "Username for the basic authentication", + "nullable": true } }, "description": "Basic Auth: Basic authentication involves sending a verified username and password with your request." @@ -12802,11 +13170,13 @@ "properties": { "key": { "type": "string", - "description": "Key for the url query parameter" + "description": "Key for the url query parameter", + "nullable": true }, "value": { "type": "string", - "description": "Value for the url query parameter" + "description": "Value for the url query parameter", + "nullable": true } } }, @@ -12815,7 +13185,8 @@ "properties": { "visibility": { "type": "boolean", - "description": "Custom action is available on all visualizations. Earlier , the naming convention: LOCAL/GLOBAL. TRUE signifies GLOBAL for backward compatibility." + "description": "Custom action is available on all visualizations. Earlier , the naming convention: LOCAL/GLOBAL. TRUE signifies GLOBAL for backward compatibility.", + "nullable": true } }, "description": "Default Custom action configuration. This includes the custom action's visibility across all visualizations and Answers. By default, a custom action is added to all visualizations and Answers." @@ -12847,11 +13218,13 @@ "properties": { "position": { "type": "string", - "description": "Position of the Custom action on the Metadata object. Earlier naming convention: context." + "description": "Position of the Custom action on the Metadata object. Earlier naming convention: context.", + "nullable": true }, "visibility": { "type": "boolean", - "description": "Visibility of the metadata association with custom action. Earlier naming convention: enabled" + "description": "Visibility of the metadata association with custom action. Earlier naming convention: enabled", + "nullable": true } }, "description": "Specify that the association is enabled for the metadata object" @@ -12869,7 +13242,8 @@ "ANSWER", "WORKSHEET" ], - "description": "Type of metadata object." + "description": "Type of metadata object.", + "nullable": true }, "identifier": { "type": "string", @@ -12882,10 +13256,12 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "nullable": true }, "name": { - "type": "string" + "type": "string", + "nullable": true } } }, @@ -12893,10 +13269,12 @@ "type": "object", "properties": { "id": { - "type": "string" + "type": "string", + "nullable": true }, "name": { - "type": "string" + "type": "string", + "nullable": true } } }, @@ -12922,25 +13300,29 @@ "type": "array", "items": { "$ref": "#/components/schemas/JWT_Metadata_Object" - } + }, + "nullable": true } }, - "description": "*Deprecated from 9.10.5.cl.* \n \nJWT user options to create a JWT token given the payload. Use user_parameters for Attribute-Based Access Control (ABAC). \nFor more information, see https://developers.thoughtspot.com/docs/abac-user-parameters." + "description": "JWT user options to create a JWT token given the payload." }, "JWT_Parameter": { "type": "object", "properties": { "runtime_filter": { "type": "object", - "description": "Runtime filter parameter type in JWT." + "description": "Runtime filter parameter type in JWT.", + "nullable": true }, "runtime_sort": { "type": "object", - "description": "Runtime sort parameter type in JWT." + "description": "Runtime sort parameter type in JWT.", + "nullable": true }, "runtime_param_override": { "type": "object", - "description": "Runtime param override type in JWT." + "description": "Runtime param override type in JWT.", + "nullable": true } }, "description": "List of runtime parameters need to set during the session." @@ -12949,14 +13331,16 @@ "type": "object", "properties": { "identifier": { - "type": "string" + "type": "string", + "nullable": true }, "type": { "type": "string", "enum": [ "LIVEBOARD", "ANSWER" - ] + ], + "nullable": true } }, "description": "Metadata objects." @@ -12968,33 +13352,38 @@ "type": "array", "items": { "$ref": "#/components/schemas/User_Object" - } + }, + "nullable": true }, "runtime_filters": { "type": "array", "items": { "$ref": "#/components/schemas/User_Runtime_Filters" - } + }, + "nullable": true }, "runtime_sorts": { "type": "array", "items": { "$ref": "#/components/schemas/User_Runtime_Sorts" - } + }, + "nullable": true }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/User_Parameters" - } + }, + "nullable": true }, "compress": { "type": "boolean", "default": false, - "description": " Version: 9.12.0.cl or later" + "description": " Version: 9.12.0.cl or later", + "nullable": true } }, - "description": "Define attributes such as Runtime filters and Runtime parameters to send security entitlements to a user session. For more information, \nsee https://developers.thoughtspot.com/docs/abac-user-parameters." + "description": "User properties runtime_filters,runtime_sorts,parameters applicable to LOGICAL_TABLE(Worksheet)" }, "User_Object": { "type": "object", @@ -13009,7 +13398,8 @@ "ANSWER", "LOGICAL_TABLE" ], - "description": "Type of object." + "description": "Type of object.", + "nullable": true }, "identifier": { "type": "string", @@ -13060,14 +13450,16 @@ "persist": { "type": "boolean", "default": false, - "description": "Flag to persist the runtime filters.
Version: 9.12.0.cl or later" + "description": "Flag to persist the runtime filters.
Version: 9.12.0.cl or later", + "nullable": true }, "objects": { "type": "array", "items": { "$ref": "#/components/schemas/User_Object" }, - "description": "Object to apply the runtime filter." + "description": "Object to apply the runtime filter.", + "nullable": true } }, "description": "Objects to apply the User_Runtime_Filters." @@ -13077,7 +13469,8 @@ "properties": { "column_name": { "type": "string", - "description": "The column name to apply filter." + "description": "The column name to apply filter.", + "nullable": true }, "order": { "type": "string", @@ -13085,19 +13478,22 @@ "ASC", "DESC" ], - "description": "Order for the sort." + "description": "Order for the sort.", + "nullable": true }, "persist": { "type": "boolean", "default": false, - "description": "Flag to persist the runtime sorts.
Version: 9.12.0.cl or later" + "description": "Flag to persist the runtime sorts.
Version: 9.12.0.cl or later", + "nullable": true }, "objects": { "type": "array", "items": { "$ref": "#/components/schemas/User_Object" }, - "description": "Object to apply the runtime sort." + "description": "Object to apply the runtime sort.", + "nullable": true } }, "description": "Objects to apply the User_Runtime_Sorts." @@ -13123,14 +13519,16 @@ "persist": { "type": "boolean", "default": false, - "description": "Flag to persist the parameters.
Version: 9.12.0.cl or later" + "description": "Flag to persist the parameters.
Version: 9.12.0.cl or later", + "nullable": true }, "objects": { "type": "array", "items": { "$ref": "#/components/schemas/User_Object" }, - "description": "Object to apply the runtime parameter." + "description": "Object to apply the runtime parameter.", + "nullable": true } }, "description": "Objects to apply the Runtime_Parameters." @@ -13187,11 +13585,13 @@ "org_id": { "type": "integer", "format": "int32", - "description": "Unique identifier of the metadata." + "description": "Unique identifier of the metadata.", + "nullable": true }, "metadata_id": { "type": "string", - "description": "Unique identifier of the Org." + "description": "Unique identifier of the Org.", + "nullable": true } } }, @@ -13202,10 +13602,11 @@ "type": "array", "items": { "$ref": "#/components/schemas/JWT_Parameter" - } + }, + "nullable": true } }, - "description": "*Deprecated from 9.10.5.cl.*\nJWT user options to create a JWT token given the payload. Use user_parameters for Attribute-Based Access Control (ABAC). \nFor more information, see https://developers.thoughtspot.com/docs/abac-user-parameters." + "description": "JWT user options to create a JWT token given the payload." }, "TokenValidationResponse": { "type": "object", @@ -13246,7 +13647,8 @@ "properties": { "activation_link": { "type": "string", - "description": "Activation link to activate the user." + "description": "Activation link to activate the user.", + "nullable": true } }, "description": "The object representation with activation link." @@ -13268,7 +13670,8 @@ }, "password": { "type": "string", - "description": "Password of the user." + "description": "Password of the user.", + "nullable": true }, "account_type": { "type": "string", @@ -13280,7 +13683,8 @@ "REMOTE_USER" ], "default": "LOCAL_USER", - "description": "Type of the user account." + "description": "Type of the user account.", + "nullable": true }, "account_status": { "type": "string", @@ -13292,25 +13696,29 @@ "PENDING" ], "default": "ACTIVE", - "description": "Status of the user account." + "description": "Status of the user account.", + "nullable": true }, "email": { "type": "string", - "description": "Email address of the user." + "description": "Email address of the user.", + "nullable": true }, "org_identifiers": { "type": "array", "items": { "type": "string" }, - "description": "ID or name of the Orgs to which the user belongs." + "description": "ID or name of the Orgs to which the user belongs.", + "nullable": true }, "group_identifiers": { "type": "array", "items": { "type": "string" }, - "description": "ID or name of the groups to which the user belongs." + "description": "ID or name of the groups to which the user belongs.", + "nullable": true }, "visibility": { "type": "string", @@ -13318,31 +13726,37 @@ "SHARABLE", "NON_SHARABLE" ], - "description": "Visibility of the users. The SHARABLE property makes a user visible to other users and group, who can share objects with the user." + "description": "Visibility of the users. The SHARABLE property makes a user visible to other users and group, who can share objects with the user.", + "nullable": true }, "notify_on_share": { "type": "boolean", "default": true, - "description": "Notify user when other users or groups share metadata objects" + "description": "Notify user when other users or groups share metadata objects", + "nullable": true }, "show_onboarding_experience": { "type": "boolean", - "description": "Show or hide the new user onboarding walkthroughs" + "description": "Show or hide the new user onboarding walkthroughs", + "nullable": true }, "onboarding_experience_completed": { "type": "boolean", - "description": "Revisit the new user onboarding walkthroughs" + "description": "Revisit the new user onboarding walkthroughs", + "nullable": true }, "home_liveboard_identifier": { "type": "string", - "description": "Unique ID or name of the default Liveboard assigned to the user." + "description": "Unique ID or name of the default Liveboard assigned to the user.", + "nullable": true }, "favorite_metadata": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteMetadataInput" }, - "description": "Metadata objects to add to the user's favorites list." + "description": "Metadata objects to add to the user's favorites list.", + "nullable": true } } }, @@ -13353,19 +13767,22 @@ "type": "array", "items": { "$ref": "#/components/schemas/ImportUserType" - } + }, + "nullable": true }, "users_updated": { "type": "array", "items": { "$ref": "#/components/schemas/ImportUserType" - } + }, + "nullable": true }, "users_deleted": { "type": "array", "items": { "$ref": "#/components/schemas/ImportUserType" - } + }, + "nullable": true } } }, @@ -13377,7 +13794,8 @@ "properties": { "id": { "type": "string", - "description": "Unique identifier of the user." + "description": "Unique identifier of the user.", + "nullable": true }, "name": { "type": "string", @@ -13400,7 +13818,8 @@ "LOGICAL_COLUMN", "CONNECTION" ], - "description": "Type of metadata (Optional when given identifier is ID).\n1. LIVEBOARD\n2. ANSWERS\n3. LOGICAL_TABLE for any data object such as table, worksheet or view.\n4. LOGICAL_COLUMN for a column of any data object such as tables, worksheets or views." + "description": "Type of metadata (Optional when given identifier is ID).\n1. LIVEBOARD\n2. ANSWERS\n3. LOGICAL_TABLE for any data object such as table, worksheet or view.\n4. LOGICAL_COLUMN for a column of any data object such as tables, worksheets or views.", + "nullable": true }, "identifier": { "type": "string", @@ -13428,11 +13847,13 @@ "items": { "type": "string" }, - "description": "Unique ID of Liveboards that will be assigned as default Liveboards to the users in the group." + "description": "Unique ID of Liveboards that will be assigned as default Liveboards to the users in the group.", + "nullable": true }, "description": { "type": "string", - "description": "Description of the group." + "description": "Description of the group.", + "nullable": true }, "privileges": { "type": "array", @@ -13460,17 +13881,22 @@ "LIVEBOARD_VERIFIER", "PREVIEW_THOUGHTSPOT_SAGE", "CAN_MANAGE_VERSION_CONTROL", - "THIRDPARTY_ANALYSIS" + "THIRDPARTY_ANALYSIS", + "ALLOW_NON_EMBED_FULL_APP_ACCESS", + "CAN_ACCESS_ANALYST_STUDIO", + "CAN_MANAGE_ANALYST_STUDIO" ] }, - "description": "Privileges that will be assigned to the group." + "description": "Privileges that will be assigned to the group.", + "nullable": true }, "sub_group_identifiers": { "type": "array", "items": { "type": "string" }, - "description": "Unique ID or name of the sub-groups to add to the group." + "description": "Unique ID or name of the sub-groups to add to the group.", + "nullable": true }, "type": { "type": "string", @@ -13478,14 +13904,16 @@ "LOCAL_GROUP", "LDAP_GROUP" ], - "description": "Type of the group." + "description": "Type of the group.", + "nullable": true }, "user_identifiers": { "type": "array", "items": { "type": "string" }, - "description": "Unique ID or name of the users to assign to the group." + "description": "Unique ID or name of the users to assign to the group.", + "nullable": true }, "visibility": { "type": "string", @@ -13493,7 +13921,8 @@ "SHARABLE", "NON_SHARABLE" ], - "description": "Visibility of the group. The SHARABLE makes a group visible to other users and groups, and thus allows them to share objects." + "description": "Visibility of the group. The SHARABLE makes a group visible to other users and groups, and thus allows them to share objects.", + "nullable": true } } }, @@ -13541,9 +13970,13 @@ "ANSWER", "LOGICAL_TABLE", "CONNECTION", - "CUSTOM_ACTION" + "CUSTOM_ACTION", + "USER", + "USER_GROUP", + "ROLE" ], - "description": "Type of metadata (Optional when given identifier is ID)." + "description": "Type of metadata (Optional when given identifier is ID).", + "nullable": true }, "identifier": { "type": "string", @@ -13567,7 +14000,8 @@ "LOGICAL_COLUMN", "LOGICAL_RELATIONSHIP" ], - "description": "Type of metadata (Optional when given identifier is ID)." + "description": "Type of metadata (Optional when given identifier is ID).", + "nullable": true }, "identifier": { "type": "string", @@ -13589,7 +14023,8 @@ "ANSWER", "LOGICAL_TABLE" ], - "description": "Type of metadata." + "description": "Type of metadata.", + "nullable": true }, "identifier": { "type": "string", @@ -13598,6 +14033,28 @@ }, "description": "MetadataType InputType used in Author API's" }, + "ShareMetadataTypeInput": { + "type": "object", + "required": [ + "identifier" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "LIVEBOARD", + "ANSWER", + "LOGICAL_TABLE" + ], + "description": "Type of metadata (Optional when given identifier is ID).", + "nullable": true + }, + "identifier": { + "type": "string", + "description": "Unique ID or name of the metadata object." + } + } + }, "SharePermissionsInput": { "type": "object", "required": [ @@ -13638,7 +14095,8 @@ "LOGICAL_TABLE", "CUSTOM_ACTION" ], - "description": "Type of metadata." + "description": "Type of metadata.", + "nullable": true } } }, @@ -13647,34 +14105,41 @@ "properties": { "committer": { "$ref": "#/components/schemas/CommiterType", - "description": "Repository user using which changes were committed" + "description": "Repository user using which changes were committed", + "nullable": true }, "author": { "$ref": "#/components/schemas/AuthorType", - "description": "Thoughtspot user who commits the changes" + "description": "Thoughtspot user who commits the changes", + "nullable": true }, "comment": { "type": "string", - "description": "Comments associated with the commit" + "description": "Comments associated with the commit", + "nullable": true }, "commit_time": { "type": "string", - "description": "Time at which the changes were committed." + "description": "Time at which the changes were committed.", + "nullable": true }, "commit_id": { "type": "string", - "description": "SHA id associated with the commit" + "description": "SHA id associated with the commit", + "nullable": true }, "branch": { "type": "string", - "description": "Branch where changes were committed" + "description": "Branch where changes were committed", + "nullable": true }, "committed_files": { "type": "array", "items": { "$ref": "#/components/schemas/CommitFileType" }, - "description": "Files that were pushed as part of this commit" + "description": "Files that were pushed as part of this commit", + "nullable": true } } }, @@ -13695,7 +14160,8 @@ }, "status_message": { "type": "string", - "description": "Any error or warning with the deployment" + "description": "Any error or warning with the deployment", + "nullable": true } } }, @@ -13704,41 +14170,49 @@ "properties": { "committer": { "$ref": "#/components/schemas/CommiterType", - "description": "Repository user using which changes were committed" + "description": "Repository user using which changes were committed", + "nullable": true }, "author": { "$ref": "#/components/schemas/AuthorType", - "description": "Thoughtspot user who commits the changes" + "description": "Thoughtspot user who commits the changes", + "nullable": true }, "comment": { "type": "string", - "description": "Comments associated with the commit" + "description": "Comments associated with the commit", + "nullable": true }, "commit_time": { "type": "string", - "description": "Time at which the changes were committed." + "description": "Time at which the changes were committed.", + "nullable": true }, "commit_id": { "type": "string", - "description": "SHA id associated with the commit" + "description": "SHA id associated with the commit", + "nullable": true }, "branch": { "type": "string", - "description": "Branch where changes were committed" + "description": "Branch where changes were committed", + "nullable": true }, "committed_files": { "type": "array", "items": { "$ref": "#/components/schemas/CommitFileType" }, - "description": "Files that were pushed as part of this commit" + "description": "Files that were pushed as part of this commit", + "nullable": true }, "reverted_metadata": { "type": "array", "items": { "$ref": "#/components/schemas/RevertedMetadata" }, - "description": "Metadata of reverted file of this commit" + "description": "Metadata of reverted file of this commit", + "nullable": true } } }, @@ -13779,23 +14253,28 @@ "properties": { "file_name": { "type": "string", - "description": "Name of the file deployed" + "description": "Name of the file deployed", + "nullable": true }, "metadata_name": { "type": "string", - "description": "Name of the metadata object" + "description": "Name of the metadata object", + "nullable": true }, "metadata_type": { "type": "string", - "description": "Type of the metadata object" + "description": "Type of the metadata object", + "nullable": true }, "status_code": { "type": "string", - "description": "Indicates the status of deployment for the file" + "description": "Indicates the status of deployment for the file", + "nullable": true }, "status_message": { "type": "string", - "description": "Any error or warning with the deployment" + "description": "Any error or warning with the deployment", + "nullable": true } } }, @@ -13853,7 +14332,8 @@ }, "details": { "type": "object", - "description": "Details of the connection." + "description": "Details of the connection.", + "nullable": true } } }, @@ -13862,7 +14342,8 @@ "properties": { "status": { "type": "boolean", - "description": "Status of the connection diff." + "description": "Status of the connection diff.", + "nullable": true } } }, @@ -13890,21 +14371,24 @@ "groups_assigned_count": { "type": "integer", "format": "int32", - "description": "number of groups assigned with this role" + "description": "number of groups assigned with this role", + "nullable": true }, "orgs": { "type": "array", "items": { "$ref": "#/components/schemas/GenericInfo" }, - "description": "Orgs in which role exists." + "description": "Orgs in which role exists.", + "nullable": true }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/GenericInfo" }, - "description": "Details of groups assigned with this role" + "description": "Details of groups assigned with this role", + "nullable": true }, "privileges": { "type": "array", @@ -13938,7 +14422,10 @@ "CAN_MANAGE_WORKSHEET_VIEWS_TABLES", "CAN_MANAGE_VERSION_CONTROL", "THIRDPARTY_ANALYSIS", - "CAN_CREATE_CATALOG" + "CAN_CREATE_CATALOG", + "ALLOW_NON_EMBED_FULL_APP_ACCESS", + "CAN_ACCESS_ANALYST_STUDIO", + "CAN_MANAGE_ANALYST_STUDIO" ] }, "description": "Privileges granted to the role." @@ -13950,43 +14437,53 @@ "MODIFY", "NO_ACCESS" ], - "description": "Permission details of the Role" + "description": "Permission details of the Role", + "nullable": true }, "author_id": { "type": "string", - "description": "Unique identifier of author of the role." + "description": "Unique identifier of author of the role.", + "nullable": true }, "modifier_id": { "type": "string", - "description": "Unique identifier of modifier of the role." + "description": "Unique identifier of modifier of the role.", + "nullable": true }, "creation_time_in_millis": { "type": "object", - "description": "Creation time of the role in milliseconds." + "description": "Creation time of the role in milliseconds.", + "nullable": true }, "modification_time_in_millis": { "type": "object", - "description": "Last modified time of the role in milliseconds." + "description": "Last modified time of the role in milliseconds.", + "nullable": true }, "deleted": { "type": "boolean", - "description": "Indicates whether the role is deleted." + "description": "Indicates whether the role is deleted.", + "nullable": true }, "deprecated": { "type": "boolean", - "description": "Indicates whether the role is deprecated." + "description": "Indicates whether the role is deprecated.", + "nullable": true }, "external": { "type": "boolean", - "description": "Indicates whether the role is external." + "description": "Indicates whether the role is external.", + "nullable": true }, "hidden": { "type": "boolean", - "description": "Indicates whether the role is hidden." + "description": "Indicates whether the role is hidden.", + "nullable": true }, "shared_via_connection": { "type": "boolean", - "description": "Indicates whether the role is shared via connection" + "description": "Indicates whether the role is shared via connection", + "nullable": true } } }, @@ -14011,42 +14508,51 @@ "properties": { "complete_liveboard": { "type": "boolean", - "description": "Indicates whether to include complete Liveboard." + "description": "Indicates whether to include complete Liveboard.", + "nullable": true }, "include_cover_page": { "type": "boolean", - "description": "Indicates whether to include cover page with the Liveboard title." + "description": "Indicates whether to include cover page with the Liveboard title.", + "nullable": true }, "include_custom_logo": { "type": "boolean", - "description": "Indicates whether to include customized wide logo in the footer if available." + "description": "Indicates whether to include customized wide logo in the footer if available.", + "nullable": true }, "include_filter_page": { "type": "boolean", - "description": "Indicates whether to include a page with all applied filters." + "description": "Indicates whether to include a page with all applied filters.", + "nullable": true }, "include_page_number": { "type": "boolean", - "description": "Indicates whether to include page number in the footer of each page" + "description": "Indicates whether to include page number in the footer of each page", + "nullable": true }, "page_footer_text": { "type": "string", - "description": "Text to include in the footer of each page." + "description": "Text to include in the footer of each page.", + "nullable": true }, "page_orientation": { "type": "string", - "description": "Page orientation of the PDF." + "description": "Page orientation of the PDF.", + "nullable": true }, "page_size": { "type": "string", "enum": [ "A4" ], - "description": "Page size." + "description": "Page size.", + "nullable": true }, "truncate_table": { "type": "boolean", - "description": "Indicates whether to include only first page of the tables." + "description": "Indicates whether to include only first page of the tables.", + "nullable": true } }, "description": "Options for PDF export." @@ -14110,14 +14616,16 @@ "items": { "type": "string" }, - "description": "Emails of the recipients." + "description": "Emails of the recipients.", + "nullable": true }, "principals": { "type": "array", "items": { "$ref": "#/components/schemas/PrincipalsListItemInput" }, - "description": "User or groups to be set as recipients of the schedule notifications." + "description": "User or groups to be set as recipients of the schedule notifications.", + "nullable": true } }, "description": "Recipients of the scheduled job notification." @@ -14163,7 +14671,8 @@ }, "description": { "type": "string", - "description": "Description of the job." + "description": "Description of the job.", + "nullable": true }, "file_format": { "type": "string", @@ -14179,7 +14688,8 @@ }, "liveboard_options": { "$ref": "#/components/schemas/LiveboardOptions", - "description": "Options to specify details of Liveboard." + "description": "Options to specify details of Liveboard.", + "nullable": true }, "metadata": { "$ref": "#/components/schemas/MetadataResponse", @@ -14191,7 +14701,8 @@ }, "pdf_options": { "$ref": "#/components/schemas/PdfOptions", - "description": "Options for PDF export." + "description": "Options for PDF export.", + "nullable": true }, "recipient_details": { "$ref": "#/components/schemas/RecipientDetails", @@ -14199,7 +14710,8 @@ }, "status": { "type": "string", - "description": "Status of the job" + "description": "Status of the job", + "nullable": true }, "time_zone": { "type": "string", @@ -14210,7 +14722,8 @@ "items": { "$ref": "#/components/schemas/ResponseScheduleRun" }, - "description": "Schedule runs history records." + "description": "Schedule runs history records.", + "nullable": true } } }, @@ -14307,7 +14820,8 @@ ], "properties": { "name": { - "type": "string" + "type": "string", + "nullable": true }, "id": { "type": "string" @@ -14325,42 +14839,51 @@ "properties": { "complete_liveboard": { "type": "boolean", - "description": "Indicates whether to include complete Liveboard." + "description": "Indicates whether to include complete Liveboard.", + "nullable": true }, "include_cover_page": { "type": "boolean", - "description": "Indicates whether to include cover page with the Liveboard title." + "description": "Indicates whether to include cover page with the Liveboard title.", + "nullable": true }, "include_custom_logo": { "type": "boolean", - "description": "Indicates whether to include customized wide logo in the footer if available." + "description": "Indicates whether to include customized wide logo in the footer if available.", + "nullable": true }, "include_filter_page": { "type": "boolean", - "description": "Indicates whether to include a page with all applied filters." + "description": "Indicates whether to include a page with all applied filters.", + "nullable": true }, "include_page_number": { "type": "boolean", - "description": "Indicates whether to include page number in the footer of each page" + "description": "Indicates whether to include page number in the footer of each page", + "nullable": true }, "page_footer_text": { "type": "string", - "description": "Text to include in the footer of each page." + "description": "Text to include in the footer of each page.", + "nullable": true }, "page_orientation": { "type": "string", - "description": "Page orientation of the PDF." + "description": "Page orientation of the PDF.", + "nullable": true }, "page_size": { "type": "string", "enum": [ "A4" ], - "description": "Page size." + "description": "Page size.", + "nullable": true }, "truncate_table": { "type": "boolean", - "description": "Indicates whether to include only first page of the tables." + "description": "Indicates whether to include only first page of the tables.", + "nullable": true } }, "description": "Options for PDF export." @@ -14373,14 +14896,16 @@ "items": { "type": "string" }, - "description": "Emails of the recipients. Specify email address if the recipient is not a ThoughtSpot user." + "description": "Emails of the recipients. Specify email address if the recipient is not a ThoughtSpot user.", + "nullable": true }, "principals": { "type": "array", "items": { "$ref": "#/components/schemas/PrincipalsListItem" }, - "description": "List of user or groups to subscribe for the scheduled job notifications." + "description": "List of user or groups to subscribe for the scheduled job notifications.", + "nullable": true } }, "description": "Recipient configuration which includes email address, ID or name of the users and groups." @@ -14431,7 +14956,8 @@ }, "detail": { "type": "string", - "description": "Message details related to the schedule run." + "description": "Message details related to the schedule run.", + "nullable": true } }, "description": "Schedule run response object" @@ -14440,13 +14966,15 @@ "type": "object", "properties": { "identifier": { - "type": "string" + "type": "string", + "nullable": true }, "type": { "type": "string", "enum": [ "LIVEBOARD" - ] + ], + "nullable": true } } }, @@ -14455,11 +14983,13 @@ "properties": { "field_name": { "type": "string", - "description": "Name of the field to apply the sort on." + "description": "Name of the field to apply the sort on.", + "nullable": true }, "order": { "type": "string", - "description": "Sort order : ASC(Ascending) or DESC(Descending)." + "description": "Sort order : ASC(Ascending) or DESC(Descending).", + "nullable": true } }, "description": "Sort options." @@ -14470,19 +15000,22 @@ "include_history_runs": { "type": "boolean", "default": false, - "description": "Indicates whether to fetch history runs for the scheduled notification." + "description": "Indicates whether to fetch history runs for the scheduled notification.", + "nullable": true }, "record_size": { "type": "integer", "format": "int32", "default": 10, - "description": "Indicates the max number of records that can be fetched as past runs of any scheduled job." + "description": "Indicates the max number of records that can be fetched as past runs of any scheduled job.", + "nullable": true }, "record_offset": { "type": "integer", "format": "int32", "default": 0, - "description": "Indicates the starting record number from where history runs records should be fetched." + "description": "Indicates the starting record number from where history runs records should be fetched.", + "nullable": true } } }, @@ -14491,11 +15024,13 @@ "properties": { "CALLBACK": { "$ref": "#/components/schemas/CALLBACKInputMandatory", - "description": "CALLBACK Custom Action Type" + "description": "CALLBACK Custom Action Type", + "nullable": true }, "URL": { "$ref": "#/components/schemas/URLInputMandatory", - "description": "URL Custom Action Type" + "description": "URL Custom Action Type", + "nullable": true } }, "description": "Action details includes Type and Configuration for Custom Actions, either Callback or URL is required.\nWhen both callback and url are provided, callback would be considered" @@ -14505,7 +15040,8 @@ "properties": { "reference": { "type": "string", - "description": "Reference name. By default, the value will be set to action name." + "description": "Reference name. By default, the value will be set to action name.", + "nullable": true } }, "description": "CALLBACK Custom Action Type" @@ -14518,14 +15054,16 @@ "properties": { "authentication": { "$ref": "#/components/schemas/AuthenticationInput", - "description": "Authorization type for the custom action." + "description": "Authorization type for the custom action.", + "nullable": true }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/ParametersListItemInput" }, - "description": "Query parameters for url." + "description": "Query parameters for url.", + "nullable": true }, "url": { "type": "string", @@ -14533,7 +15071,8 @@ }, "reference": { "type": "string", - "description": "Reference name. By default the value will be set to action name" + "description": "Reference name. By default the value will be set to action name", + "nullable": true } }, "description": "URL Custom Action Type" @@ -14543,19 +15082,23 @@ "properties": { "API_Key": { "$ref": "#/components/schemas/API_KeyInput", - "description": "With API key auth, you send a key-value pair to the API either in the request headers or query parameters." + "description": "With API key auth, you send a key-value pair to the API either in the request headers or query parameters.", + "nullable": true }, "Basic_Auth": { "$ref": "#/components/schemas/Basic_AuthInput", - "description": "Basic Auth: Basic authentication involves sending a verified username and password with your request." + "description": "Basic Auth: Basic authentication involves sending a verified username and password with your request.", + "nullable": true }, "Bearer_Token": { "type": "string", - "description": "Bearer tokens enable requests to authenticate using an access key." + "description": "Bearer tokens enable requests to authenticate using an access key.", + "nullable": true }, "No_Auth": { "type": "string", - "description": "No authorization. If your request doesn't require authorization." + "description": "No authorization. If your request doesn't require authorization.", + "nullable": true } }, "description": "Authorization type for the custom action." @@ -14565,11 +15108,13 @@ "properties": { "key": { "type": "string", - "description": "Enter your key name" + "description": "Enter your key name", + "nullable": true }, "value": { "type": "string", - "description": "Enter you key value" + "description": "Enter you key value", + "nullable": true } }, "description": "With API key auth, you send a key-value pair to the API either in the request headers or query parameters." @@ -14579,11 +15124,13 @@ "properties": { "password": { "type": "string", - "description": "Password for the basic authentication" + "description": "Password for the basic authentication", + "nullable": true }, "username": { "type": "string", - "description": "Username for the basic authentication" + "description": "Username for the basic authentication", + "nullable": true } }, "description": "Basic Auth: Basic authentication involves sending a verified username and password with your request." @@ -14593,11 +15140,13 @@ "properties": { "key": { "type": "string", - "description": "Key for the url query parameter" + "description": "Key for the url query parameter", + "nullable": true }, "value": { "type": "string", - "description": "Value for the url query parameter" + "description": "Value for the url query parameter", + "nullable": true } } }, @@ -14609,7 +15158,8 @@ "properties": { "action_config": { "$ref": "#/components/schemas/ActionConfigInputCreate", - "description": "Specify that the association is enabled for the metadata object" + "description": "Specify that the association is enabled for the metadata object", + "nullable": true }, "identifier": { "type": "string", @@ -14622,7 +15172,8 @@ "ANSWER", "WORKSHEET" ], - "description": "Type of metadata." + "description": "Type of metadata.", + "nullable": true } } }, @@ -14637,12 +15188,14 @@ "CONTEXT_MENU" ], "default": "MENU", - "description": "Position of the Custom action on the Metadata object. Earlier naming convention: context." + "description": "Position of the Custom action on the Metadata object. Earlier naming convention: context.", + "nullable": true }, "visibility": { "type": "boolean", "default": true, - "description": "Visibility of the metadata association with custom action. Earlier naming convention: enabled" + "description": "Visibility of the metadata association with custom action. Earlier naming convention: enabled", + "nullable": true } }, "description": "Specify that the association is enabled for the metadata object Default" @@ -14653,7 +15206,8 @@ "visibility": { "type": "boolean", "default": true, - "description": "Custom action is available on all visualizations. Earlier naming convention: LOCAL/GLOBAL. TRUE signifies GLOBAL for backward compatibility.\nDefault: true" + "description": "Custom action is available on all visualizations. Earlier naming convention: LOCAL/GLOBAL. TRUE signifies GLOBAL for backward compatibility.\nDefault: true", + "nullable": true } }, "description": "Default Custom action configuration. This includes the custom action's visibility across all visualizations and Answers. By default, a custom action is added to all visualizations and Answers." @@ -14663,11 +15217,13 @@ "properties": { "CALLBACK": { "$ref": "#/components/schemas/CALLBACKInput", - "description": "CALLBACK Custom Action Type" + "description": "CALLBACK Custom Action Type", + "nullable": true }, "URL": { "$ref": "#/components/schemas/URLInput", - "description": "URL Custom Action Type" + "description": "URL Custom Action Type", + "nullable": true } }, "description": "Action details includes `Type` and configuration details of Custom Actions. Either Callback or URL is required." @@ -14677,7 +15233,8 @@ "properties": { "reference": { "type": "string", - "description": "Reference name. By default, the value will be set to action name." + "description": "Reference name. By default, the value will be set to action name.", + "nullable": true } }, "description": "CALLBACK Custom Action Type" @@ -14687,22 +15244,26 @@ "properties": { "authentication": { "$ref": "#/components/schemas/AuthenticationInput", - "description": "Authorization type for the custom action." + "description": "Authorization type for the custom action.", + "nullable": true }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/ParametersListItemInput" }, - "description": "Query parameters for url." + "description": "Query parameters for url.", + "nullable": true }, "url": { "type": "string", - "description": "Request Url for the Custom action." + "description": "Request Url for the Custom action.", + "nullable": true }, "reference": { "type": "string", - "description": "Reference name. By default the value will be set to action name" + "description": "Reference name. By default the value will be set to action name", + "nullable": true } }, "description": "URL Custom Action Type" @@ -14712,11 +15273,13 @@ "properties": { "action_config": { "$ref": "#/components/schemas/ActionConfigInput", - "description": "Specify that the association is enabled for the metadata object" + "description": "Specify that the association is enabled for the metadata object", + "nullable": true }, "identifier": { "type": "string", - "description": "Unique ID or name of the metadata." + "description": "Unique ID or name of the metadata.", + "nullable": true }, "type": { "type": "string", @@ -14725,7 +15288,8 @@ "ANSWER", "WORKSHEET" ], - "description": "Type of metadata." + "description": "Type of metadata.", + "nullable": true } } }, @@ -14739,11 +15303,13 @@ "PRIMARY", "CONTEXT_MENU" ], - "description": "Position of the Custom action on the Metadata object. Earlier naming convention: context." + "description": "Position of the Custom action on the Metadata object. Earlier naming convention: context.", + "nullable": true }, "visibility": { "type": "boolean", - "description": "Visibility of the metadata association with custom action. Earlier naming convention: enabled" + "description": "Visibility of the metadata association with custom action. Earlier naming convention: enabled", + "nullable": true } }, "description": "Specify that the association is enabled for the metadata object Default" @@ -14753,7 +15319,8 @@ "properties": { "visibility": { "type": "boolean", - "description": "Custom action is available on all visualizations. Earlier naming convention: LOCAL/GLOBAL. TRUE signifies GLOBAL for backward compatibility." + "description": "Custom action is available on all visualizations. Earlier naming convention: LOCAL/GLOBAL. TRUE signifies GLOBAL for backward compatibility.", + "nullable": true } }, "description": "Default Custom action configuration. This includes the custom action's visibility across all visualizations and Answers. By default, a custom action is added to all visualizations and Answers." @@ -14771,7 +15338,8 @@ }, "model_path": { "type": "string", - "description": "Model directory path, this is optional param and required if there are duplicate models with the same name." + "description": "Model directory path, this is optional param and required if there are duplicate models with the same name.", + "nullable": true }, "tables": { "type": "array", @@ -14786,25 +15354,32 @@ "type": "object", "properties": { "dbt_connection_identifier": { - "type": "string" + "type": "string", + "nullable": true }, "project_name": { - "type": "string" + "type": "string", + "nullable": true }, "connection_id": { - "type": "string" + "type": "string", + "nullable": true }, "connection_name": { - "type": "string" + "type": "string", + "nullable": true }, "cdw_database": { - "type": "string" + "type": "string", + "nullable": true }, "import_type": { - "type": "string" + "type": "string", + "nullable": true }, "author_name": { - "type": "string" + "type": "string", + "nullable": true } } }, @@ -14861,4 +15436,4 @@ } } ] -} +} \ No newline at end of file